diff --git a/classes/zh_CN/class_@gdscript.rst b/classes/zh_CN/class_@gdscript.rst index f77b7d5338..6ef4070744 100644 --- a/classes/zh_CN/class_@gdscript.rst +++ b/classes/zh_CN/class_@gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gdscript/doc_classes/@GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/@GDScript.xml. .. _class_@GDScript: @@ -41,7 +41,7 @@ +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`assert`\ (\ condition\: :ref:`bool`, message\: :ref:`String` = ""\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`char`\ (\ char\: :ref:`int`\ ) | + | :ref:`String` | :ref:`char`\ (\ code\: :ref:`int`\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`convert`\ (\ what\: :ref:`Variant`, type\: :ref:`Variant.Type`\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,6 +57,8 @@ +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`load`\ (\ path\: :ref:`String`\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`ord`\ (\ char\: :ref:`String`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`preload`\ (\ path\: :ref:`String`\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`print_debug`\ (\ ...\ ) |vararg| | @@ -109,7 +111,9 @@ **NAN** = ``nan`` :ref:`🔗` -“Not a Number”（非数），一个无效的浮点数值。\ :ref:`NAN` 有许多特殊的性质，比如 ``!=`` 始终返回 ``true``\ ，而其他比较运算符都始终返回 ``false``\ 。即便是和自己比较也是如此（\ ``NAN == NAN`` 返回 ``false``\ ，而 ``NAN != NAN`` 返回 ``true``\ ）。部分无效运算会返回这个值，例如将浮点数 ``0.0`` 除以 ``0.0``\ 。 +“Not a Number”（非数）是一个无效的浮点数值。部分无效运算会返回这个值，例如将浮点数 ``0.0`` 除以 ``0.0``\ 。 + +\ :ref:`NAN` 有许多特殊的性质，包括 ``!=`` 始终返回 ``true``\ ，而其他比较运算符都始终返回 ``false``\ 。即便是和自己比较也是如此（\ ``NAN == NAN`` 返回 ``false``\ ，而 ``NAN != NAN`` 返回 ``true``\ ）。因此，你必须使用 :ref:`@GlobalScope.is_nan()` 来判断数值是否等于 :ref:`NAN`\ 。 \ **警告：**\ “非数”只是浮点数的概念，整数中没有对应的概念。将整数 ``0`` 除以 ``0`` 不会得到 :ref:`NAN`\ ，而是会产生运行时错误。 @@ -120,6 +124,37 @@ 注解 ---- +.. _class_@GDScript_annotation_@abstract: + +.. rst-class:: classref-annotation + +**@abstract**\ (\ ) :ref:`🔗` + +将类或方法标记为抽象。 + +抽象类是一种无法直接实例化的类，主要功能是被其他类继承。尝试实例化抽象类会报错。 + +抽象方法是一种没有实现的方法，因此函数头之后应当为换行或分号。抽象方法定义的是派生类所必须遵守的契约，覆盖方法时签名必须兼容。派生类必须为所有抽象方法都提供实现，否则就必须将它标记为抽象类。如果类中至少存在一个抽象方法（可以是自己定义的，也可以是继承但没实现的），那么也必须标记为抽象类。 + +反之则不然：抽象类可以不包含抽象方法。 + +:: + + @abstract class Shape: + @abstract func draw() + + class Circle extends Shape: + func draw(): + print("画个圆形。") + + class Square extends Shape: + func draw(): + print("画个方形。") + +.. rst-class:: classref-item-separator + +---- + .. _class_@GDScript_annotation_@export: .. rst-class:: classref-annotation @@ -131,27 +166,27 @@ :: extends Node - + enum Direction {LEFT, RIGHT, UP, DOWN} - + # 内置类型。 @export var string = "" @export var int_number = 5 @export var float_number: float = 5 - + # 枚举。 @export var type: Variant.Type @export var format: Image.Format @export var direction: Direction - + # 资源。 @export var image: Image @export var custom_resource: CustomResource - + # 节点。 @export var node: Node @export var custom_node: CustomNode - + # 类型数组。 @export var int_array: Array[int] @export var direction_array: Array[Direction] @@ -259,7 +294,7 @@ @export_enum("Warrior", "Magician", "Thief") var character_class: int @export_enum("Slow:30", "Average:60", "Very Fast:200") var character_speed: int @export_enum("Rebecca", "Mary", "Leah") var character_name: String - + @export_enum("Sword", "Spear", "Mace") var character_items: Array[int] @export_enum("double_jump", "climb", "dash") var character_skills: Array[String] @@ -275,7 +310,7 @@ enum CharacterName {REBECCA, MARY, LEAH} @export var character_name: CharacterName - + enum CharacterItem {SWORD, SPEAR, MACE} @export var character_items: Array[CharacterItem] @@ -310,7 +345,7 @@ **@export_file**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` -导出 :ref:`String`\ 、\ :ref:`Array`\ \[:ref:`String`\ \[ 或 :ref:`PackedStringArray` 属性，用作指向文件的路径。该路径会被限制在项目文件夹及其子文件夹中。要允许在整个文件系统中选取，见 :ref:`@export_global_file`\ 。 +导出 :ref:`String`\ 、\ :ref:`Array`\ \[:ref:`String`\ \] 或 :ref:`PackedStringArray` 属性，用作指向文件的路径。该路径会被限制在项目文件夹及其子文件夹中。要允许在整个文件系统中选取，见 :ref:`@export_global_file`\ 。 如果提供了 ``filter``\ ，则只有匹配的文件可供选取。 @@ -322,6 +357,20 @@ @export_file("*.txt") var notes_path: String @export_file var level_paths: Array[String] +\ **注意：**\ 如果文件的 UID 可用，则会以 UID 形式进行存储和引用。这样可以保证即便文件发生移动，引用也仍然有效。可以使用 :ref:`ResourceUID` 中的方法将 UID 转换为路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GDScript_annotation_@export_file_path: + +.. rst-class:: classref-annotation + +**@export_file_path**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` + +与 :ref:`@export_file` 相同，但是文件以原始路径的形式存储。这意味着移动文件后可能失效。导出 :ref:`Resource` 路径时，请考虑改用 :ref:`@export_file`\ 。 + .. rst-class:: classref-item-separator ---- @@ -564,11 +613,11 @@ @export_group("Racer Properties") @export var nickname = "Nick" @export var age = 26 - + @export_group("Car Properties", "car_") @export var car_label = "Speedy" @export var car_number = 3 - + @export_group("", "") @export var ungrouped_number = 3 @@ -655,10 +704,10 @@ @export_range(-10, 20) var number @export_range(-10, 20, 0.2) var number: float @export_range(0, 20) var numbers: Array[float] - + @export_range(0, 100, 1, "or_greater") var power_percent @export_range(0, 100, 1, "or_greater", "or_less") var health_delta - + @export_range(-180, 180, 0.001, "radians_as_degrees") var angle_radians @export_range(0, 360, 1, "degrees") var angle_degrees @export_range(-8, 8, 2, "suffix:px") var target_offset @@ -700,7 +749,7 @@ @export_group("Racer Properties") @export var nickname = "Nick" @export var age = 26 - + @export_subgroup("Car Properties", "car_") @export var car_label = "Speedy" @export var car_number = 3 @@ -742,14 +791,14 @@ @tool extends Sprite2D - + @export_tool_button("你好") var hello_action = hello @export_tool_button("随机颜色！", "ColorRect") var randomize_color_action = randomize_color - + func hello(): print("你好世界！") - + func randomize_color(): var undo_redo = EditorInterface.get_editor_undo_redo() undo_redo.create_action("随机设置 Sprite2D 的颜色") @@ -831,13 +880,15 @@ @rpc func fn(): pass - + @rpc("any_peer", "unreliable_ordered") func fn_update_pos(): pass - + @rpc("authority", "call_remote", "unreliable", 0) # 等价于 @rpc func fn_default(): pass +\ **注意：**\ 使用 :ref:`@rpc` 注解的方法无法接收在 :ref:`Object._init()` 中定义了必要参数的对象。更多详情，请参阅 :ref:`Object._init()`\ 。 + .. rst-class:: classref-item-separator ---- @@ -997,15 +1048,16 @@ .. rst-class:: classref-method -:ref:`String` **char**\ (\ char\: :ref:`int`\ ) :ref:`🔗` +:ref:`String` **char**\ (\ code\: :ref:`int`\ ) :ref:`🔗` -返回给定的 Unicode 码位（与 ASCII 码兼容）对应的单个字符（形式为 :ref:`String`\ ）。 +返回给定 Unicode 码位 ``code`` 的单个字符（作为长度为 1 的 :ref:`String`\ ）。 :: - var upper = char(65) # upper 是 "A" - var lower = char(65 + 32) # lower 是 "a" - var euro = char(8364) # euro 是 "€" + print(char(65)) # 打印 "A" + print(char(129302)) # 打印 "🤖" （机器人脸的emoji） + +这是 :ref:`ord()` 的逆运算。参见 :ref:`String.chr()` 和 :ref:`String.unicode_at()`\ 。 .. rst-class:: classref-item-separator @@ -1025,7 +1077,7 @@ var a = [4, 2.5, 1.2] print(a is Array) # 输出 true - + var b = convert(a, TYPE_PACKED_BYTE_ARRAY) print(b) # 输出 [4, 2, 1] print(b is Array) # 输出 false @@ -1060,10 +1112,10 @@ func _ready(): foo() - + func foo(): bar() - + func bar(): print(get_stack()) @@ -1073,9 +1125,9 @@ [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] -\ **注意：**\ 只有在运行的实例连接到调试服务器（即编辑器实例）后，该函数才有效。\ :ref:`get_stack()` 不适用于以发布模式导出的项目；或者在未连接到调试服务器的情况下，以调试模式导出的项目。 +参见 :ref:`print_debug()`\ ，\ :ref:`print_stack()` 和 :ref:`Engine.capture_script_backtraces()`\ 。 -\ **注意：**\ 不支持从 :ref:`Thread` 调用此函数，这样做将返回一个空数组。 +\ **注意：** 默认情况下，调用堆栈跟踪仅在编辑器构建和调试构建中可用。若要为发布构建启用该功能，您需要启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks`\ 。 .. rst-class:: classref-item-separator @@ -1089,7 +1141,7 @@ **已弃用：** Consider using :ref:`JSON.from_native()` or :ref:`Object.get_property_list()` instead. -返回传入的\ ``instance``\ 并转换为一个字典。对序列化很有用。 +将传入的实例 ``instance`` 转换为 :ref:`Dictionary` 并返回。适用于序列化。 :: @@ -1106,9 +1158,9 @@ [@subpath, @path, foo] [, res://test.gd, bar] -\ **提醒：**\ 这个函数只能用于序列化附加了另存为文件的\ :ref:`GDScript`\ 对象。对象没有附加脚本、附加脚本用其他语言编写、附加了内建脚本的情况下是不支持的。 +\ **注意：**\ 只有附加了存储在单独文件中的 :ref:`GDScript` 的对象才能够被这个函数序列化。不支持未附加脚本的对象、使用其他语言脚本的对象、使用内置脚本的对象。 -\ **提醒：**\ 这个函数不是递归的，这意味着嵌套的对象将不会被表示为字典。并且，以引用方式（\ :ref:`Object`\ 、\ :ref:`Dictionary`\ 、\ :ref:`Array`, 以及打包数组（packed arrays））传入的属性也是以引用方式复制，而不是建立副本。 +\ **注意：**\ 这个函数不会进行递归操作，嵌套的对象不会以字典形式表示。另外，按引用传递的属性（\ :ref:`Object`\ 、\ :ref:`Dictionary`\ 、\ :ref:`Array`\ 、紧缩数组等）会按引用进行复制，不会制作副本。 .. rst-class:: classref-item-separator @@ -1128,7 +1180,7 @@ - :ref:`Script`\ （可以用任何类，包括内部类）。 -\ ``type`` 可以不是常量，这一点与 ``is`` 的右操作数不同，\ ``is`` 运算符支持的功能更多（例如类型化数组）。如果你不需要动态类型检查，请使用该运算符，不要使用此方法。 +\ ``type`` 可以不是常量，这一点与 ``is`` 的右操作数不同，\ ``is`` 运算符支持的功能更多（例如类型化数组）。如果你不需要动态地检查类型，请使用该运算符，不要使用此方法。 \ **示例：**\ @@ -1139,7 +1191,7 @@ print(is_instance_of(a, MyClass)) print(is_instance_of(a, MyClass.InnerClass)) -\ **注意：**\ 如果 ``value`` 和/或 ``type`` 为已释放的对象（见 :ref:`@GlobalScope.is_instance_valid()`\ ），或者 ``type`` 的数值不为以上选项中的任何一项，则此方法会报运行时错误。 +\ **注意：**\ 如果 ``value`` 和/或 ``type`` 为已释放的对象（见 :ref:`@GlobalScope.is_instance_valid()`\ ），或者 ``type`` 不为以上选项中的任何一项，则此方法会报运行时错误。 另见 :ref:`@GlobalScope.typeof()`\ 、\ :ref:`type_exists()`\ 、\ :ref:`Array.is_same_typed()`\ （以及其他 :ref:`Array` 方法）。 @@ -1159,7 +1211,7 @@ var a = [1, 2, 3, 4] len(a) # 返回 4 - + var b = "Hello!" len(b) # 返回 6 @@ -1194,6 +1246,25 @@ ---- +.. _class_@GDScript_method_ord: + +.. rst-class:: classref-method + +:ref:`int` **ord**\ (\ char\: :ref:`String`\ ) :ref:`🔗` + +返回一个整数，表示给定字符 ``char`` 的 Unicode 码位，该字符应为长度为 1 的字符串。 + +:: + + print(ord(“A”)) # 输出 65 + print(ord(“🤖”)) # 输出 129302 + +这是 :ref:`char()` 的逆运算。参见 :ref:`String.chr()` 和 :ref:`String.unicode_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_@GDScript_method_preload: .. rst-class:: classref-method @@ -1230,7 +1301,9 @@ Test print At: res://test.gd:15:_process() -\ **注意：**\ 不支持从 :ref:`Thread` 中调用此方法，这样做会输出线程 ID。 +参见 :ref:`print_stack()`\ ，\ :ref:`get_stack()` 和 :ref:`Engine.capture_script_backtraces()`\ 。 + +\ **注意：** 默认情况下，调用堆栈仅在编辑器构建和调试构建中可用。若要使其在发布构建中也可用，您需要启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks`\ 。 .. rst-class:: classref-item-separator @@ -1242,17 +1315,17 @@ |void| **print_stack**\ (\ ) :ref:`🔗` -输出当前代码位置的栈追踪。另见 :ref:`get_stack()`\ 。 +在当前代码位置打印堆栈跟踪。 -控制台中的输出是类似这样的： +控制台输出可能类似于以下内容： .. code:: text Frame 0 - res://test.gd:16 in function '_process' -\ **注意：**\ 只有在运行的实例连接到调试服务器（即编辑器实例）后，该函数才有效。\ :ref:`print_stack()` 不适用于以发布模式导出的项目；或者在未连接到调试服务器的情况下，以调试模式导出的项目。 +参见 :ref:`print_debug()`\ ，\ :ref:`get_stack()` 和 :ref:`Engine.capture_script_backtraces()`\ 。 -\ **注意：**\ 不支持从 :ref:`Thread` 调用此函数，这样做将改为打印线程 ID。 +\ **注意：** 默认情况下，堆栈跟踪仅在编辑器构建和调试构建中可用。若要使其在发布构建中也可用，需启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks`\ 。 .. rst-class:: classref-item-separator @@ -1334,6 +1407,7 @@ type_exists("NonExistentClass") # 返回 false .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_@globalscope.rst b/classes/zh_CN/class_@globalscope.rst index 98dd2ec901..1b25843f84 100644 --- a/classes/zh_CN/class_@globalscope.rst +++ b/classes/zh_CN/class_@globalscope.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/@GlobalScope.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/@GlobalScope.xml. .. _class_@GlobalScope: @@ -2837,7 +2837,7 @@ enum **JoyAxis**: :ref:`🔗` :ref:`JoyAxis` **JOY_AXIS_TRIGGER_RIGHT** = ``5`` -游戏控制器左扳机轴。 +游戏控制器右扳机轴。 .. _class_@GlobalScope_constant_JOY_AXIS_SDL_MAX: @@ -3052,7 +3052,7 @@ enum **Error**: :ref:`🔗` var error = method_that_returns_error() if error != OK: printerr("失败！") - + # 或者也可以： if error: printerr("还是失败！") @@ -3587,7 +3587,7 @@ enum **PropertyHint**: :ref:`🔗` :ref:`PropertyHint` **PROPERTY_HINT_FILE** = ``13`` -提示 :ref:`String` 属性为文件的路径。编辑时会弹出选取路径的文件对话框。提示字符串可以设为一组带有通配符的筛选器，例如 ``"*.png,*.jpg"``\ 。 +提示 :ref:`String` 属性为文件的路径。编辑时会弹出选取路径的文件对话框。提示字符串可以设为一组带有通配符的筛选器，例如 ``"*.png,*.jpg"``\ 。默认情况下，如果文件的 UID 可用，则会以 UID 形式进行存储。可以使用 :ref:`ResourceUID` 中的方法将 UID 转换回路径。要存储原始路径，请使用 :ref:`PROPERTY_HINT_FILE_PATH`\ 。 .. _class_@GlobalScope_constant_PROPERTY_HINT_DIR: @@ -3671,6 +3671,8 @@ enum **PropertyHint**: :ref:`🔗` 如果属性为 :ref:`Array`\ ，则提示编辑器如何显示其中的元素。\ ``hint_string`` 必须使用 ``":"`` 和 ``"/"`` 对内嵌的类型进行编码。 +如果属性为 :ref:`Dictionary`\ ，则提示编辑器如何显示其中的元素。\ ``hint_string`` 与 :ref:`Array` 相同，使用 ``";"`` 分隔键和值。 + .. tabs:: @@ -3713,7 +3715,7 @@ enum **PropertyHint**: :ref:`🔗` hint_string = "%d/%d:Zero,One,Three:3,Six:6" % [TYPE_INT, PROPERTY_HINT_ENUM] # 整数数组（枚举）。 hint_string = "%d/%d:*.png" % [TYPE_STRING, PROPERTY_HINT_FILE] # 字符串数组（文件路径）。 hint_string = "%d/%d:Texture2D" % [TYPE_OBJECT, PROPERTY_HINT_RESOURCE_TYPE] # 纹理数组。 - + hint_string = "%d:%d:" % [TYPE_ARRAY, TYPE_FLOAT] # 浮点数二维数组。 hint_string = "%d:%d/%d:" % [TYPE_ARRAY, TYPE_STRING, PROPERTY_HINT_MULTILINE_TEXT] # 多行字符串二维数组。 hint_string = "%d:%d/%d:-1,1,0.1" % [TYPE_ARRAY, TYPE_FLOAT, PROPERTY_HINT_RANGE] # 浮点数二维数组（范围为 -1 到 1）。 @@ -3726,7 +3728,7 @@ enum **PropertyHint**: :ref:`🔗` hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Three:3,Six:6"; // 整数数组（枚举）。 hintString = $"{Variant.Type.String:D}/{PropertyHint.File:D}:*.png"; // 字符串数组（文件路径）。 hintString = $"{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // 纹理数组。 - + hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}:"; // 浮点数二维数组。 hintString = $"{Variant.Type.Array:D}:{Variant.Type.String:D}/{PropertyHint.MultilineText:D}:"; // 多行字符串二维数组。 hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}/{PropertyHint.Range:D}:-1,1,0.1"; // 浮点数二维数组（范围为 -1 到 1）。 @@ -3802,7 +3804,9 @@ enum **PropertyHint**: :ref:`🔗` :ref:`PropertyHint` **PROPERTY_HINT_ARRAY_TYPE** = ``31`` -提示属性是一个 :ref:`Array`\ ，其存储类型在提示字符串中指定。 +提示属性为 :ref:`Array`\ ，其中所存储的类型在提示字符串中指定。提示字符串中包含的是数组的类型（例如 ``"String"``\ ）。 + +对存储的类型进行更精细的控制请使用 :ref:`PROPERTY_HINT_TYPE_STRING` 中的提示字符串。 .. _class_@GlobalScope_constant_PROPERTY_HINT_DICTIONARY_TYPE: @@ -3810,7 +3814,9 @@ enum **PropertyHint**: :ref:`🔗` :ref:`PropertyHint` **PROPERTY_HINT_DICTIONARY_TYPE** = ``38`` -提示属性是一个 :ref:`Dictionary`\ ，其存储类型在提示字符串中指定。 +提示属性为 :ref:`Dictionary`\ ，其中所存储的类型在提示字符串中指定。提示字符串中包含的是键和值的类型，由英文分号分隔（例如 ``"int;String"``\ ）。 + +对存储的类型进行更精细的控制请使用 :ref:`PROPERTY_HINT_TYPE_STRING` 中的提示字符串。 .. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID: @@ -3875,11 +3881,41 @@ enum **PropertyHint**: :ref:`🔗` 提示一个属性在设置后仍会自动被改变，例如\ :ref:`AudioStreamPlayer.playing`\ 或\ :ref:`GPUParticles3D.emitting`\ 。 +.. _class_@GlobalScope_constant_PROPERTY_HINT_GROUP_ENABLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`PropertyHint` **PROPERTY_HINT_GROUP_ENABLE** = ``42`` + +提示布尔值属性会启用属性所在分组对应的功能。属性会以复选框的形式在分组标题上显示。仅在分组或子分组中有效。 + +默认情况下，禁用该属性会隐藏分组中的所有属性。请使用可选的提示字符串 ``"checkbox_only"`` 禁用该行为。 + +.. _class_@GlobalScope_constant_PROPERTY_HINT_INPUT_NAME: + +.. rst-class:: classref-enumeration-constant + +:ref:`PropertyHint` **PROPERTY_HINT_INPUT_NAME** = ``43`` + +提示 :ref:`String` 和 :ref:`StringName` 属性为输入动作的名称。允许选择项目设置“输入映射”中的动作名称。提示字符串可以包含两个选项，由英文逗号分隔： + +- 如果包含 ``"show_builtin"`` 则选项中包含内置输入动作。 + +- 如果包含 ``"loose_mode"`` 则启用宽松模式，允许插入任意动作名称，可以是输入映射中不存在的名称。 + +.. _class_@GlobalScope_constant_PROPERTY_HINT_FILE_PATH: + +.. rst-class:: classref-enumeration-constant + +:ref:`PropertyHint` **PROPERTY_HINT_FILE_PATH** = ``44`` + +与 :ref:`PROPERTY_HINT_FILE` 类似，但是属性以原始路径的形式存储，不使用 UID。这意味着移动文件后引用可能损坏。请尽量使用 :ref:`PROPERTY_HINT_FILE`\ 。 + .. _class_@GlobalScope_constant_PROPERTY_HINT_MAX: .. rst-class:: classref-enumeration-constant -:ref:`PropertyHint` **PROPERTY_HINT_MAX** = ``42`` +:ref:`PropertyHint` **PROPERTY_HINT_MAX** = ``45`` 代表 :ref:`PropertyHint` 枚举的大小。 @@ -4225,7 +4261,7 @@ flags **MethodFlags**: :ref:`🔗` :ref:`MethodFlags` **METHOD_FLAG_VIRTUAL_REQUIRED** = ``128`` -必选虚方法的标志。 +必选虚方法的标志。GDScript 会为抽象函数设置该标志。 .. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT: @@ -5261,19 +5297,19 @@ enum **Variant.Operator**: :ref:`🔗` var a = abs(-1) # a=1 - + var b = abs(-1.2) # b=1.2 - + var c = abs(Vector2(-3.5, -4)) # c=(3.5, 4) - + var d = abs(Vector2i(-5, -6)) # d=(5, 6) - + var e = abs(Vector3(-7, 8.5, -3.8)) # e=(7, 8.5, 3.8) - + var f = abs(Vector3i(-7, -8, -9)) # f=(7, 8, 9) @@ -5346,7 +5382,7 @@ enum **Variant.Operator**: :ref:`🔗` var a = acosh(2) # 返回 1.31695789692482 cosh(a) # 返回 2 - + var b = acosh(-1) # 返回 0 .. rst-class:: classref-item-separator @@ -5451,7 +5487,7 @@ enum **Variant.Operator**: :ref:`🔗` var a = atanh(0.9) # 返回 1.47221948958322 tanh(a) # 返回 0.9 - + var b = atanh(-2) # 返回 -inf tanh(b) # 返回 -1 @@ -5572,7 +5608,7 @@ enum **Variant.Operator**: :ref:`🔗` var a = clamp(-10, -1, 5) # a 是 -1 - + var b = clamp(8.1, 0.9, 5.5) # b 是 5.5 @@ -5596,7 +5632,7 @@ enum **Variant.Operator**: :ref:`🔗` var speed = 42.1 var a = clampf(speed, 1.0, 20.5) # a 是 20.5 - + speed = -10.0 var b = clampf(speed, -1.0, 1.0) # b 是 -1.0 @@ -5616,7 +5652,7 @@ enum **Variant.Operator**: :ref:`🔗` var speed = 42 var a = clampi(speed, 1, 20) # a 是 20 - + speed = -10 var b = clampi(speed, -1, 1) # b 是 -1 @@ -5943,7 +5979,7 @@ enum **Variant.Operator**: :ref:`🔗` .. code-tab:: gdscript var drink = "water" - + func _ready(): var id = get_instance_id() var instance = instance_from_id(id) @@ -5954,7 +5990,7 @@ enum **Variant.Operator**: :ref:`🔗` public partial class MyNode : Node { public string Drink { get; set; } = "water"; - + public override void _Ready() { ulong id = GetInstanceId(); @@ -5982,7 +6018,7 @@ enum **Variant.Operator**: :ref:`🔗` # 下面的 `lerp()` 调用时的插值比例是 0.75。 var middle = lerp(20, 30, 0.75) # middle 现在是 27.5。 - + # 现在，我们假装忘记了原来的比例，想要找到是多少。 var ratio = inverse_lerp(20, 30, 27.5) # ratio 现在是 0.75。 @@ -6015,7 +6051,7 @@ enum **Variant.Operator**: :ref:`🔗` :ref:`bool` **is_finite**\ (\ x\: :ref:`float`\ ) :ref:`🔗` -返回 ``x`` 是否为有限值，即不是 :ref:`@GDScript.NAN`\ 、正无穷大或负无穷大。 +返回 ``x`` 是否为有限值，即不是 :ref:`@GDScript.NAN`\ 、正无穷大或负无穷大。另见 :ref:`is_inf()` 和 :ref:`is_nan()`\ 。 .. rst-class:: classref-item-separator @@ -6027,7 +6063,7 @@ enum **Variant.Operator**: :ref:`🔗` :ref:`bool` **is_inf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` -如果 ``x`` 是正无穷大或负无穷大，则返回 ``true`` 。 +如果 ``x`` 是正无穷大或负无穷大，则返回 ``true`` 。另见 :ref:`is_finite()` 和 :ref:`is_nan()`\ 。 .. rst-class:: classref-item-separator @@ -6063,7 +6099,7 @@ enum **Variant.Operator**: :ref:`🔗` :ref:`bool` **is_nan**\ (\ x\: :ref:`float`\ ) :ref:`🔗` -如果 ``x`` 是 NaN（“非数字”或无效）值，则返回 ``true`` 。 +如果 ``x`` 为 NaN 值（“Not a Number”，不是数字，即无效值），则返回 ``true``\ 。存在的该方法必要性在于 :ref:`@GDScript.NAN` 与自身不相等，即无法使用 ``x == NAN`` 来判断是否为 NaN。 .. rst-class:: classref-item-separator @@ -6086,7 +6122,7 @@ enum **Variant.Operator**: :ref:`🔗` is_same(vec2_a, vec2_a) # true is_same(vec2_a, vec2_b) # true is_same(vec2_a, vec2_c) # false - + # Array 是引用类型 var arr_a = [] var arr_b = [] @@ -6357,7 +6393,7 @@ enum **Variant.Operator**: :ref:`🔗` nearest_po2(3) # 返回 4 nearest_po2(4) # 返回 4 nearest_po2(5) # 返回 8 - + nearest_po2(0) # 返回 0（可能出乎意料） nearest_po2(-1) # 返回 0（可能出乎意料） @@ -6500,8 +6536,6 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 \ **注意：**\ 请考虑使用 :ref:`push_error()` 和 :ref:`push_warning()` 来打印错误和警告消息，而不是 :ref:`print()` 或 :ref:`print_rich()`\ 。这将它们与用于调试目的的打印消息区分开来，同时还会在打印错误或警告时显示堆栈跟踪。 -\ **注意：**\ 在 Windows 中，只有 Windows 10 及后续版本能够在标准输出中正确显示 ANSI 转义码。 - \ **注意：**\ 在编辑器中显示的输出支持可点击的 ``[url=address]文本[/url]`` 标签。点击时， ``[url]`` 标签的 ``address`` 值由 :ref:`OS.shell_open()` 处理。 .. rst-class:: classref-item-separator @@ -6711,7 +6745,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 :: var a = rand_from_seed(4) - + print(a[0]) # 输出 2879024997 print(a[1]) # 输出 4 @@ -7018,7 +7052,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 sign(0.0) # 返回 0 sign(6.0) # 返回 1 sign(NAN) # 返回 0 - + sign(Vector3(-6.0, 0.0, 6.0)) # 返回 (-1, 0, 1) \ **注意：**\ 为了更好的类型安全，请使用 :ref:`signf()`\ 、\ :ref:`signi()`\ 、\ :ref:`Vector2.sign()`\ 、\ :ref:`Vector2i.sign()`\ 、\ :ref:`Vector3.sign()`\ 、\ :ref:`Vector3i.sign()`\ 、\ :ref:`Vector4.sign()` 或 :ref:`Vector4i.sign()`\ 。 @@ -7143,7 +7177,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 snapped(100, 32) # 返回 96 snapped(3.14159, 0.01) # 返回 3.14 - + snapped(Vector2(34, 70), Vector2(8, 8)) # 返回 (32, 72) 另见 :ref:`ceil()`\ 、\ :ref:`floor()` 和 :ref:`round()`\ 。 @@ -7198,7 +7232,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 :ref:`float` **sqrt**\ (\ x\: :ref:`float`\ ) :ref:`🔗` -返回 ``x`` 的平方根，其中 ``x`` 是一个非负数。 +返回 ``x`` 的平方根，\ ``x`` 为非负数。 :: @@ -7467,7 +7501,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 :ref:`Variant` **wrap**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) :ref:`🔗` -在 ``min`` 和 ``max`` 之间包裹 :ref:`Variant` ``value``\ 。可用于创建类似循环的行为或无限曲面。 +在 ``min`` 和 ``max`` 之间包裹 :ref:`Variant` ``value``\ 。\ ``min`` *包含*\ 端点，\ ``max`` 则\ *不包含*\ 。可用于创建类似循环的行为或无限表面。 支持变体类型 :ref:`int` 和 :ref:`float`\ 。如果任一参数是 :ref:`float`\ ，则该函数返回 :ref:`float`\ ，否则返回 :ref:`int`\ 。 @@ -7475,10 +7509,10 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 var a = wrap(4, 5, 10) # a 为 9 （整数类型） - + var a = wrap(7, 5, 10) # a 为 7 （整数类型） - + var a = wrap(10.5, 5, 10) # a 为 5.5 （浮点类型） @@ -7492,7 +7526,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 :ref:`float` **wrapf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` -在 ``min`` 和 ``max`` 之间将浮点数 ``value`` 循环。可用于创建类似循环的行为或无限曲面。 +在 ``min`` 和 ``max`` 之间将浮点数 ``value`` 循环。\ ``min`` *包含*\ 端点，\ ``max`` 则\ *不包含*\ 。可用于创建类似循环的行为或无限表面。 :: @@ -7509,9 +7543,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 # 无限旋转（弧度） angle = wrapf(angle + 0.1, -PI, PI) -\ **注意：**\ 如果 ``min`` 为 ``0``\ ，则相当于 :ref:`fposmod()`\ ，因此请改用它。 - -通过让用户控制最小值，\ :ref:`wrapf()` 比使用 :ref:`fposmod()` 方法更灵活。 +\ **注意：**\ 如果 ``min`` 为 ``0``\ ，则相当于 :ref:`fposmod()`\ ，因此请优先使用后者。通过让用户控制最小值，\ :ref:`wrapf()` 比使用 :ref:`fposmod()` 方法更灵活。 .. rst-class:: classref-item-separator @@ -7523,7 +7555,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 :ref:`int` **wrapi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) :ref:`🔗` -在 ``min`` 和 ``max`` 之间环绕整数 ``value``\ 。 可用于创建类似循环的行为或无限曲面。 +在 ``min`` 和 ``max`` 之间环绕整数 ``value``\ 。\ ``min`` *包含*\ 端点，\ ``max`` 则\ *不包含*\ 。可用于创建类似循环的行为或无限曲面。 :: @@ -7536,6 +7568,7 @@ URL 标签仅支持在 URL 标签中包含 URL，不支持使用不同标题的 var result = wrapi(-6, -5, -1) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_aabb.rst b/classes/zh_CN/class_aabb.rst index 517b438156..ec0b8c01e4 100644 --- a/classes/zh_CN/class_aabb.rst +++ b/classes/zh_CN/class_aabb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AABB.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AABB.xml. .. _class_AABB: @@ -286,7 +286,7 @@ AABB var a = AABB(Vector3(0, 0, 0), Vector3(4, 4, 4)) var b = AABB(Vector3(1, 1, 1), Vector3(3, 3, 3)) var c = AABB(Vector3(2, 2, 2), Vector3(8, 8, 8)) - + print(a.encloses(a)) # 打印 true print(a.encloses(b)) # 打印 true print(a.encloses(c)) # 打印 false @@ -296,7 +296,7 @@ AABB var a = new Aabb(new Vector3(0, 0, 0), new Vector3(4, 4, 4)); var b = new Aabb(new Vector3(1, 1, 1), new Vector3(3, 3, 3)); var c = new Aabb(new Vector3(2, 2, 2), new Vector3(8, 8, 8)); - + GD.Print(a.Encloses(a)); // 打印 True GD.Print(a.Encloses(b)); // 打印 True GD.Print(a.Encloses(c)); // 打印 False @@ -321,11 +321,11 @@ AABB .. code-tab:: gdscript var box = AABB(Vector3(0, 0, 0), Vector3(5, 2, 5)) - + box = box.expand(Vector3(10, 0, 0)) print(box.position) # 输出 (0.0, 0.0, 0.0) print(box.size) # 输出 (10.0, 2.0, 5.0) - + box = box.expand(Vector3(-5, 0, 5)) print(box.position) # 输出 (-5.0, 0.0, 0.0) print(box.size) # 输出 (15.0, 2.0, 5.0) @@ -333,11 +333,11 @@ AABB .. code-tab:: csharp var box = new Aabb(new Vector3(0, 0, 0), new Vector3(5, 2, 5)); - + box = box.Expand(new Vector3(10, 0, 0)); GD.Print(box.Position); // 输出 (0, 0, 0) GD.Print(box.Size); // 输出 (10, 2, 5) - + box = box.Expand(new Vector3(-5, 0, 5)); GD.Print(box.Position); // 输出 (-5, 0, 0) GD.Print(box.Size); // 输出 (15, 2, 5) @@ -386,7 +386,7 @@ AABB .. code-tab:: gdscript var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8)) - + print(box.get_longest_axis()) # 输出 (0.0, 0.0, 1.0) print(box.get_longest_axis_index()) # 输出 2 print(box.get_longest_axis_size()) # 输出 8.0 @@ -394,7 +394,7 @@ AABB .. code-tab:: csharp var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8)); - + GD.Print(box.GetLongestAxis()); // 输出 (0, 0, 1) GD.Print(box.GetLongestAxisIndex()); // 输出 Z GD.Print(box.GetLongestAxisSize()); // 输出 8 @@ -449,7 +449,7 @@ AABB .. code-tab:: gdscript var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8)) - + print(box.get_shortest_axis()) # 输出 (1.0, 0.0, 0.0) print(box.get_shortest_axis_index()) # 输出 0 print(box.get_shortest_axis_size()) # 输出 2.0 @@ -457,7 +457,7 @@ AABB .. code-tab:: csharp var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8)); - + GD.Print(box.GetShortestAxis()); // 输出 (1, 0, 0) GD.Print(box.GetShortestAxisIndex()); // 输出 X GD.Print(box.GetShortestAxisSize()); // 输出 2 @@ -538,7 +538,7 @@ AABB var a = AABB(Vector3(4, 4, 4), Vector3(8, 8, 8)).grow(4) print(a.position) # 输出 (0.0, 0.0, 0.0) print(a.size) # 输出 (16.0, 16.0, 16.0) - + var b = AABB(Vector3(0, 0, 0), Vector3(8, 4, 2)).grow(2) print(b.position) # 输出 (-2.0, -2.0, -2.0) print(b.size) # 输出 (12.0, 8.0, 6.0) @@ -548,7 +548,7 @@ AABB var a = new Aabb(new Vector3(4, 4, 4), new Vector3(8, 8, 8)).Grow(4); GD.Print(a.Position); // 输出 (0, 0, 0) GD.Print(a.Size); // 输出 (16, 16, 16) - + var b = new Aabb(new Vector3(0, 0, 0), new Vector3(8, 4, 2)).Grow(2); GD.Print(b.Position); // 输出 (-2, -2, -2) GD.Print(b.Size); // 输出 (12, 8, 6) @@ -612,7 +612,7 @@ AABB var box1 = AABB(Vector3(0, 0, 0), Vector3(5, 2, 8)) var box2 = AABB(Vector3(2, 0, 2), Vector3(8, 4, 4)) - + var intersection = box1.intersection(box2) print(intersection.position) # 输出 (2.0, 0.0, 2.0) print(intersection.size) # 输出 (3.0, 2.0, 4.0) @@ -621,7 +621,7 @@ AABB var box1 = new Aabb(new Vector3(0, 0, 0), new Vector3(5, 2, 8)); var box2 = new Aabb(new Vector3(2, 0, 2), new Vector3(8, 4, 4)); - + var intersection = box1.Intersection(box2); GD.Print(intersection.Position); // 输出 (2, 0, 2) GD.Print(intersection.Size); // 输出 (3, 2, 4) @@ -768,6 +768,7 @@ AABB \ **注意：**\ 由于浮点数精度误差，请考虑改用 :ref:`is_equal_approx()`\ ，会更可靠。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_acceptdialog.rst b/classes/zh_CN/class_acceptdialog.rst index a719d6a2ce..4a807f104a 100644 --- a/classes/zh_CN/class_acceptdialog.rst +++ b/classes/zh_CN/class_acceptdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AcceptDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AcceptDialog.xml. .. _class_AcceptDialog: @@ -44,7 +44,11 @@ AcceptDialog +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | keep_title_visible | ``true`` (overrides :ref:`Window`) | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`ok_button_text` | ``"OK"`` | + | :ref:`bool` | maximize_disabled | ``true`` (overrides :ref:`Window`) | + +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | minimize_disabled | ``true`` (overrides :ref:`Window`) | + +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ok_button_text` | ``""`` | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Alert!"`` (overrides :ref:`Window`) | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -134,7 +138,7 @@ AcceptDialog **custom_action**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` -按下自定义按钮时发出。见 :ref:`add_button()`\ 。 +按下带有动作的自定义按钮时发出。参见 :ref:`add_button()`\ 。 .. rst-class:: classref-section-separator @@ -173,7 +177,7 @@ AcceptDialog - |void| **set_close_on_escape**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_close_on_escape**\ (\ ) -如果为 ``true``\ ，当按下退出键（\ :ref:`@GlobalScope.KEY_ESCAPE`\ ）时，对话框将被隐藏。 +如果为 ``true``\ ，则按下 ``ui_cancel`` 动作时会隐藏对话框（该动作默认绑定至 :ref:`@GlobalScope.KEY_ESCAPE`\ ）。 .. rst-class:: classref-item-separator @@ -219,14 +223,14 @@ AcceptDialog .. rst-class:: classref-property -:ref:`String` **ok_button_text** = ``"OK"`` :ref:`🔗` +:ref:`String` **ok_button_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ok_button_text**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_ok_button_text**\ (\ ) -确定按钮（参见 :ref:`get_ok_button()`\ ）显示的文本。 +确定按钮显示的文本（见 :ref:`get_ok_button()`\ ）。留空时使用默认文本。 .. rst-class:: classref-section-separator @@ -243,7 +247,9 @@ AcceptDialog :ref:`Button` **add_button**\ (\ text\: :ref:`String`, right\: :ref:`bool` = false, action\: :ref:`String` = ""\ ) :ref:`🔗` -将带有标签 ``text`` 和自定义 ``action`` 的按钮添加到对话框，并返回该创建的按钮。\ ``action`` 将在按钮被按下时传递给 :ref:`custom_action` 信号。 +将带有标签 ``text`` 和自定义 ``action`` 的按钮添加到对话框，并返回该创建的按钮。 + +如果 ``action`` 不为空，按下按钮将发出具有指定动作字符串的 :ref:`custom_action` 信号。 如果 ``right`` 为 ``true``\ ，按钮会被放置在所有同级按钮的右侧。 @@ -369,6 +375,7 @@ AcceptDialog 填充窗口背景的面板。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_aescontext.rst b/classes/zh_CN/class_aescontext.rst index b78c7a6322..a319730953 100644 --- a/classes/zh_CN/class_aescontext.rst +++ b/classes/zh_CN/class_aescontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AESContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AESContext.xml. .. _class_AESContext: @@ -27,9 +27,9 @@ AESContext .. code-tab:: gdscript extends Node - + var aes = AESContext.new() - + func _ready(): var key = "My secret key!!!" # 密钥必须是 16 或 32 字节。 var data = "My secret text!!" # 数据大小必须是 16 字节的倍数，需要时添加补白。 @@ -43,7 +43,7 @@ AESContext aes.finish() # ECB 校验 assert(decrypted == data.to_utf8_buffer()) - + var iv = "My secret iv!!!!" # IV 必须是 16 字节。 # CBC 加密 aes.start(AESContext.MODE_CBC_ENCRYPT, key.to_utf8_buffer(), iv.to_utf8_buffer()) @@ -60,11 +60,11 @@ AESContext using Godot; using System.Diagnostics; - + public partial class MyNode : Node { private AesContext _aes = new AesContext(); - + public override void _Ready() { string key = "My secret key!!!"; // 密钥必须是 16 或 32 字节。 @@ -79,7 +79,7 @@ AESContext _aes.Finish(); // ECB 校验 Debug.Assert(decrypted == data.ToUtf8Buffer()); - + string iv = "My secret iv!!!!"; // IV 必须是 16 字节。 // CBC 加密 _aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8Buffer(), iv.ToUtf8Buffer()); @@ -227,6 +227,7 @@ AES 密码封锁器链式解密模式。 \ **注意：**\ ``src`` 的大小必须是 16 倍的倍数。如果需要，应用一些填充。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_aimmodifier3d.rst b/classes/zh_CN/class_aimmodifier3d.rst new file mode 100644 index 0000000000..af12de4b08 --- /dev/null +++ b/classes/zh_CN/class_aimmodifier3d.rst @@ -0,0 +1,197 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AimModifier3D.xml. + +.. _class_AimModifier3D: + +AimModifier3D +============= + +**继承：** :ref:`BoneConstraint3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**AimModifier3D** 会旋转骨骼，让它看向某个目标。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +这是 :ref:`LookAtModifier3D` 的简易版本，只允许骨骼指向参考项，不带角度限制、基于时间的插值等高级选项。 + +功能虽简，但实现了无需欧拉值的平滑跟踪，见 :ref:`set_use_euler()`\ 。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------+------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-----------------------+------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneAxis` | :ref:`get_forward_axis`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Axis` | :ref:`get_primary_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_using_euler`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_using_secondary_rotation`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_forward_axis`\ (\ index\: :ref:`int`, axis\: :ref:`BoneAxis`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_primary_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_euler`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_secondary_rotation`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_AimModifier3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +修改器中设置的数量。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_AimModifier3D_method_get_forward_axis: + +.. rst-class:: classref-method + +:ref:`BoneAxis` **get_forward_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回骨骼的向前轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_get_primary_rotation_axis: + +.. rst-class:: classref-method + +:ref:`Axis` **get_primary_rotation_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回第一个旋转的转轴。仅在 :ref:`is_using_euler()` 为 ``true`` 时启用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_is_using_euler: + +.. rst-class:: classref-method + +:ref:`bool` **is_using_euler**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果提供的旋转使用欧拉值则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_is_using_secondary_rotation: + +.. rst-class:: classref-method + +:ref:`bool` **is_using_secondary_rotation**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果提供的旋转是根据两个轴得到的，则返回 ``true``\ 。仅在 :ref:`is_using_euler()` 为 ``true`` 时启用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_set_forward_axis: + +.. rst-class:: classref-method + +|void| **set_forward_axis**\ (\ index\: :ref:`int`, axis\: :ref:`BoneAxis`\ ) :ref:`🔗` + +设置骨骼的向前轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_set_primary_rotation_axis: + +.. rst-class:: classref-method + +|void| **set_primary_rotation_axis**\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) :ref:`🔗` + +设置第一个旋转的转轴。仅在 :ref:`is_using_euler()` 为 ``true`` 时启用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_set_use_euler: + +.. rst-class:: classref-method + +|void| **set_use_euler**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果将 ``enabled`` 设为 ``true``\ ，则提供的旋转使用欧拉值。 + +如果将 ``enabled`` 设为 ``false``\ ，则提供的旋转使用根据向前轴向量与指向参考的向量生成的旋转弧。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AimModifier3D_method_set_use_secondary_rotation: + +.. rst-class:: classref-method + +|void| **set_use_secondary_rotation**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果将 ``enabled`` 设为 ``true``\ ，则提供的旋转是根据两个轴得到的，仅在 :ref:`is_using_euler()` 为 ``true`` 时启用。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_animatablebody2d.rst b/classes/zh_CN/class_animatablebody2d.rst index 4cc74aa909..aa68dddc12 100644 --- a/classes/zh_CN/class_animatablebody2d.rst +++ b/classes/zh_CN/class_animatablebody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimatableBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody2D.xml. .. _class_AnimatableBody2D: @@ -23,6 +23,15 @@ AnimatableBody2D \ **AnimatableBody2D** 发生移动时，会对线速度和角速度进行估算，并用于影响其路径上的其他物理物体。因此适用于移动平台、门等移动的对象。 +.. rst-class:: classref-introduction-group + +教程 +---- + +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + .. rst-class:: classref-reftable-group 属性 @@ -58,6 +67,7 @@ AnimatableBody2D 如果为 ``true``\ ，则物体的运动将与物理帧同步。当通过 :ref:`AnimationPlayer` 为运动设置动画时，例如在移动的平台上，这个功能很有用。\ **不要**\ 与\ :ref:`PhysicsBody2D.move_and_collide()`\ 一起使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animatablebody3d.rst b/classes/zh_CN/class_animatablebody3d.rst index ac80ed5315..cd4ad90f2d 100644 --- a/classes/zh_CN/class_animatablebody3d.rst +++ b/classes/zh_CN/class_animatablebody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimatableBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody3D.xml. .. _class_AnimatableBody3D: @@ -28,6 +28,10 @@ AnimatableBody3D 教程 ---- +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - `3D 物理测试演示 `__ - `第三人称射击（TPS）演示 `__ @@ -69,6 +73,7 @@ AnimatableBody3D 如果为 ``true``\ ，则实体的运动将与物理帧同步。当通过 :ref:`AnimationPlayer` 为运动设置动画时，例如在移动的平台上，这个功能很有用。请\ **不要**\ 与 :ref:`PhysicsBody3D.move_and_collide()` 函数一起使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animatedsprite2d.rst b/classes/zh_CN/class_animatedsprite2d.rst index 503de97596..d43f1c9924 100644 --- a/classes/zh_CN/class_animatedsprite2d.rst +++ b/classes/zh_CN/class_animatedsprite2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimatedSprite2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedSprite2D.xml. .. _class_AnimatedSprite2D: @@ -413,19 +413,18 @@ AnimatedSprite2D |void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` -将 :ref:`frame` 和 :ref:`frame_progress` 设置为给定的值。与直接设置 :ref:`frame` 不同，此方法不会隐式地将 :ref:`frame_progress` 重置为 ``0.0``\ 。 +将帧设置为 :ref:`frame`\ 、帧进度设置为 :ref:`frame_progress`\ 。与直接设置 :ref:`frame` 不同，此方法不会隐式地将 :ref:`frame_progress` 重置为 ``0.0``\ 。 -\ **示例：** 在保持相同的 :ref:`frame` 和 :ref:`frame_progress` 的情况下更改动画： +\ **示例：**\ 在保持相同的 :ref:`frame` 和 :ref:`frame_progress` 的情况下更改动画： .. tabs:: .. code-tab:: gdscript - # 更改动画的同时保留帧索引和进度。 var current_frame = animated_sprite.get_frame() var current_progress = animated_sprite.get_frame_progress() - animated_sprite.play("walk_another_skin") + animated_sprite.play("行走动画_换皮版") animated_sprite.set_frame_and_progress(current_frame, current_progress) @@ -443,6 +442,7 @@ AnimatedSprite2D 停止当前正在播放的动画。会将动画的位置重置为 ``0``\ ，并将 ``custom_speed`` 重置为 ``1.0``\ 。另见 :ref:`pause()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animatedsprite3d.rst b/classes/zh_CN/class_animatedsprite3d.rst index 69e5a990c5..e890dc9b99 100644 --- a/classes/zh_CN/class_animatedsprite3d.rst +++ b/classes/zh_CN/class_animatedsprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimatedSprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedSprite3D.xml. .. _class_AnimatedSprite3D: @@ -333,19 +333,18 @@ AnimatedSprite3D |void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` -将 :ref:`frame` 和 :ref:`frame_progress` 设置为给定的值。与直接设置 :ref:`frame` 不同，此方法不会隐式地将 :ref:`frame_progress` 重置为 ``0.0``\ 。 +将帧设置为 :ref:`frame`\ 、帧进度设置为 :ref:`frame_progress`\ 。与直接设置 :ref:`frame` 不同，此方法不会隐式地将 :ref:`frame_progress` 重置为 ``0.0``\ 。 -\ **示例：** 在保持相同的 :ref:`frame` 和 :ref:`frame_progress` 的情况下更改动画： +\ **示例：**\ 在保持相同的 :ref:`frame` 和 :ref:`frame_progress` 的情况下更改动画： .. tabs:: .. code-tab:: gdscript - # 更改动画的同时保留帧索引和进度。 var current_frame = animated_sprite.get_frame() var current_progress = animated_sprite.get_frame_progress() - animated_sprite.play("walk_another_skin") + animated_sprite.play("行走动画_换皮版") animated_sprite.set_frame_and_progress(current_frame, current_progress) @@ -363,6 +362,7 @@ AnimatedSprite3D 停止当前正在播放的动画。会将动画的位置重置为 ``0``\ ，并将 ``custom_speed`` 重置为 ``1.0``\ 。另见 :ref:`pause()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animatedtexture.rst b/classes/zh_CN/class_animatedtexture.rst index a581e9616b..873af30fd3 100644 --- a/classes/zh_CN/class_animatedtexture.rst +++ b/classes/zh_CN/class_animatedtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimatedTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedTexture.xml. .. _class_AnimatedTexture: @@ -234,6 +234,7 @@ AnimatedTexture 最多可以定义 :ref:`MAX_FRAMES` 个纹理，但要记住，只有 0 到 :ref:`frames` - 1 的帧会成为动画的一部分。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animation.rst b/classes/zh_CN/class_animation.rst index bf2979f218..3ccf28fe15 100644 --- a/classes/zh_CN/class_animation.rst +++ b/classes/zh_CN/class_animation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Animation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Animation.xml. .. _class_Animation: @@ -67,15 +67,15 @@ Animation .. table:: :widths: auto - +------------------------------------------+--------------------------------------------------------------------+---------------+ - | :ref:`bool` | :ref:`capture_included` | ``false`` | - +------------------------------------------+--------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`length` | ``1.0`` | - +------------------------------------------+--------------------------------------------------------------------+---------------+ - | :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | - +------------------------------------------+--------------------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`step` | ``0.0333333`` | - +------------------------------------------+--------------------------------------------------------------------+---------------+ + +------------------------------------------+--------------------------------------------------------------------+-----------------+ + | :ref:`bool` | :ref:`capture_included` | ``false`` | + +------------------------------------------+--------------------------------------------------------------------+-----------------+ + | :ref:`float` | :ref:`length` | ``1.0`` | + +------------------------------------------+--------------------------------------------------------------------+-----------------+ + | :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | + +------------------------------------------+--------------------------------------------------------------------+-----------------+ + | :ref:`float` | :ref:`step` | ``0.033333335`` | + +------------------------------------------+--------------------------------------------------------------------+-----------------+ .. rst-class:: classref-reftable-group @@ -575,7 +575,7 @@ enum **FindMode**: :ref:`🔗` - |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode`\ ) - :ref:`LoopMode` **get_loop_mode**\ (\ ) -确定动画播放期间动画时间轴两端的行为。 这用于动画循环的正确插值，以及提示播放器必须重新启动动画。 +确定动画播放期间动画时间轴两端的行为。这指示动画是否应该以及应该如何重新启动，也用于动画循环的正确插值。 .. rst-class:: classref-item-separator @@ -585,7 +585,7 @@ enum **FindMode**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **step** = ``0.0333333`` :ref:`🔗` +:ref:`float` **step** = ``0.033333335`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1553,9 +1553,10 @@ enum **FindMode**: :ref:`🔗` |void| **value_track_set_update_mode**\ (\ track_idx\: :ref:`int`, mode\: :ref:`UpdateMode`\ ) :ref:`🔗` -设置值轨道的更新模式（请参阅 :ref:`UpdateMode`\ ）。 +设置值轨道的更新模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationlibrary.rst b/classes/zh_CN/class_animationlibrary.rst index 07a744ec66..4bf4661b60 100644 --- a/classes/zh_CN/class_animationlibrary.rst +++ b/classes/zh_CN/class_animationlibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationLibrary.xml. .. _class_AnimationLibrary: @@ -197,6 +197,7 @@ AnimationLibrary 将与键 ``name`` 关联的 :ref:`Animation` 的键更改为 ``newname``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationmixer.rst b/classes/zh_CN/class_animationmixer.rst index 7c68c9b43f..c0656eb783 100644 --- a/classes/zh_CN/class_animationmixer.rst +++ b/classes/zh_CN/class_animationmixer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationMixer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationMixer.xml. .. _class_AnimationMixer: @@ -55,7 +55,7 @@ AnimationMixer +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ | :ref:`bool` | :ref:`reset_on_save` | ``true`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ - | :ref:`bool` | :ref:`root_motion_local` | | + | :ref:`bool` | :ref:`root_motion_local` | ``false`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ | :ref:`NodePath` | :ref:`root_motion_track` | ``NodePath("")`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ @@ -167,7 +167,9 @@ AnimationMixer **animation_started**\ (\ anim_name\: :ref:`StringName`\ ) :ref:`🔗` -当动画开始播放时发出通知。 +动画开始播放时通知。 + +\ **注意：**\ 如果动画正在循环播放，则不会发出该信号。 .. rst-class:: classref-item-separator @@ -480,7 +482,7 @@ enum **AnimationCallbackModeDiscrete**: :ref:`🔗` **root_motion_local** :ref:`🔗` +:ref:`bool` **root_motion_local** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -704,7 +706,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 .. code-tab:: gdscript var current_rotation - + func _process(delta): if Input.is_action_just_pressed("animate"): current_rotation = get_quaternion() @@ -773,7 +775,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 .. code-tab:: gdscript var prev_root_motion_position_accumulator - + func _process(delta): if Input.is_action_just_pressed("animate"): state_machine.travel("Animate") @@ -840,7 +842,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 .. code-tab:: gdscript var prev_root_motion_rotation_accumulator - + func _process(delta): if Input.is_action_just_pressed("animate"): state_machine.travel("Animate") @@ -878,7 +880,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 var current_scale = Vector3(1, 1, 1) var scale_accum = Vector3(1, 1, 1) - + func _process(delta): if Input.is_action_just_pressed("animate"): current_scale = get_scale() @@ -909,7 +911,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 .. code-tab:: gdscript var prev_root_motion_scale_accumulator - + func _process(delta): if Input.is_action_just_pressed("animate"): state_machine.travel("Animate") @@ -971,6 +973,7 @@ AnimationMixer 默认拥有一个全局库，键名为空字符串。要向这 将与键 ``name`` 关联的 :ref:`AnimationLibrary` 移动到键 ``newname``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnode.rst b/classes/zh_CN/class_animationnode.rst index fb89de0774..ac43e46096 100644 --- a/classes/zh_CN/class_animationnode.rst +++ b/classes/zh_CN/class_animationnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNode.xml. .. _class_AnimationNode: @@ -31,9 +31,9 @@ AnimationNode :: - var current_length = $AnimationTree[parameters/AnimationNodeName/current_length] - var current_position = $AnimationTree[parameters/AnimationNodeName/current_position] - var current_delta = $AnimationTree[parameters/AnimationNodeName/current_delta] + var current_length = $AnimationTree["parameters/AnimationNodeName/current_length"] + var current_position = $AnimationTree["parameters/AnimationNodeName/current_position"] + var current_delta = $AnimationTree["parameters/AnimationNodeName/current_delta"] .. rst-class:: classref-introduction-group @@ -351,7 +351,7 @@ enum **FilterAction**: :ref:`🔗` 按 ``blend`` 量混合一个动画（名称必须在链接的 :ref:`AnimationPlayer` 中有效）。可以传入时间 ``time`` 和增量 ``delta``\ ，以及表示是否发生寻道的 ``seeked``\ 。 -\ ``looped_flag`` 在循环后立即由内部处理使用。另见 :ref:`LoopedFlag`\ 。 +\ ``looped_flag`` 在循环后立即由内部处理使用。 .. rst-class:: classref-item-separator @@ -363,7 +363,7 @@ enum **FilterAction**: :ref:`🔗` :ref:`float` **blend_input**\ (\ input_index\: :ref:`int`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) :ref:`🔗` -混合一个输入。这只对为 :ref:`AnimationNodeBlendTree` 创建的动画节点有用。时间参数 ``time`` 是一个相对的增量，除非 ``seek`` 是 ``true``\ ，此时它是绝对的。可以选择传入过滤模式（选项请参阅 :ref:`FilterAction`\ ）。 +混合一个输入。这只对为 :ref:`AnimationNodeBlendTree` 创建的动画节点有用。时间参数 ``time`` 是一个相对的增量，除非 ``seek`` 是 ``true``\ ，此时它是绝对的。可以选择传入过滤模式。 .. rst-class:: classref-item-separator @@ -512,6 +512,7 @@ enum **FilterAction**: :ref:`🔗` 设置一个自定义参数。这些参数被用作本地内存，因为资源可以在树或场景中重复使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeadd2.rst b/classes/zh_CN/class_animationnodeadd2.rst index 593e0d687e..1b5eec1cd6 100644 --- a/classes/zh_CN/class_animationnodeadd2.rst +++ b/classes/zh_CN/class_animationnodeadd2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeAdd2.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAdd2.xml. .. _class_AnimationNodeAdd2: @@ -33,6 +33,7 @@ AnimationNodeAdd2 - :doc:`使用 AnimationTree <../tutorials/animation/animation_tree>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeadd3.rst b/classes/zh_CN/class_animationnodeadd3.rst index 3e3021992d..bbf60b7532 100644 --- a/classes/zh_CN/class_animationnodeadd3.rst +++ b/classes/zh_CN/class_animationnodeadd3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeAdd3.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAdd3.xml. .. _class_AnimationNodeAdd3: @@ -41,6 +41,7 @@ AnimationNodeAdd3 - `第三人称射击（TPS）演示 `__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeanimation.rst b/classes/zh_CN/class_animationnodeanimation.rst index babd1a3a69..6f8bd7d77d 100644 --- a/classes/zh_CN/class_animationnodeanimation.rst +++ b/classes/zh_CN/class_animationnodeanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAnimation.xml. .. _class_AnimationNodeAnimation: @@ -241,6 +241,7 @@ enum **PlayMode**: :ref:`🔗` 如果为 ``true``\ ，则 :ref:`AnimationNode` 会根据 :ref:`Animation` 资源提供动画并调整部分参数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeblend2.rst b/classes/zh_CN/class_animationnodeblend2.rst index f29b290430..b8d3eb7cc4 100644 --- a/classes/zh_CN/class_animationnodeblend2.rst +++ b/classes/zh_CN/class_animationnodeblend2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeBlend2.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlend2.xml. .. _class_AnimationNodeBlend2: @@ -35,6 +35,7 @@ AnimationNodeBlend2 - `第三人称射击（TPS）演示 `__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeblend3.rst b/classes/zh_CN/class_animationnodeblend3.rst index 7d415b45dc..c93ce63afc 100644 --- a/classes/zh_CN/class_animationnodeblend3.rst +++ b/classes/zh_CN/class_animationnodeblend3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeBlend3.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlend3.xml. .. _class_AnimationNodeBlend3: @@ -39,6 +39,7 @@ AnimationNodeBlend3 - :doc:`使用 AnimationTree <../tutorials/animation/animation_tree>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeblendspace1d.rst b/classes/zh_CN/class_animationnodeblendspace1d.rst index 8fb9c9144f..144e7a23ad 100644 --- a/classes/zh_CN/class_animationnodeblendspace1d.rst +++ b/classes/zh_CN/class_animationnodeblendspace1d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeBlendSpace1D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendSpace1D.xml. .. _class_AnimationNodeBlendSpace1D: @@ -137,7 +137,7 @@ enum **BlendMode**: :ref:`🔗` - |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) - :ref:`BlendMode` **get_blend_mode**\ (\ ) -控制动画之间的插值。见 :ref:`BlendMode` 常量。 +控制动画之间的插值。 .. rst-class:: classref-item-separator @@ -316,6 +316,7 @@ enum **BlendMode**: :ref:`🔗` 更新混合轴上索引 ``point`` 处的点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeblendspace2d.rst b/classes/zh_CN/class_animationnodeblendspace2d.rst index fe03c0f4b8..fa208d1e97 100644 --- a/classes/zh_CN/class_animationnodeblendspace2d.rst +++ b/classes/zh_CN/class_animationnodeblendspace2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeBlendSpace2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendSpace2D.xml. .. _class_AnimationNodeBlendSpace2D: @@ -185,7 +185,7 @@ enum **BlendMode**: :ref:`🔗` - |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) - :ref:`BlendMode` **get_blend_mode**\ (\ ) -控制动画之间的插值。见 :ref:`BlendMode` 常量。 +控制动画之间的插值。 .. rst-class:: classref-item-separator @@ -429,6 +429,7 @@ enum **BlendMode**: :ref:`🔗` 更新混合空间中索引 ``point`` 处的点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeblendtree.rst b/classes/zh_CN/class_animationnodeblendtree.rst index ef20c1aebc..118d7330a3 100644 --- a/classes/zh_CN/class_animationnodeblendtree.rst +++ b/classes/zh_CN/class_animationnodeblendtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeBlendTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendTree.xml. .. _class_AnimationNodeBlendTree: @@ -50,25 +50,27 @@ AnimationNodeBlendTree .. table:: :widths: auto - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_node_list`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -223,6 +225,18 @@ AnimationNodeBlendTree ---- +.. _class_AnimationNodeBlendTree_method_get_node_list: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`StringName`\] **get_node_list**\ (\ ) |const| :ref:`🔗` + +返回包含该混合树中所有子动画节点名称的列表。 + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationNodeBlendTree_method_get_node_position: .. rst-class:: classref-method @@ -280,6 +294,7 @@ AnimationNodeBlendTree 修改子动画节点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeextension.rst b/classes/zh_CN/class_animationnodeextension.rst index 7e5f6cd681..4e7b38c52a 100644 --- a/classes/zh_CN/class_animationnodeextension.rst +++ b/classes/zh_CN/class_animationnodeextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeExtension.xml. .. _class_AnimationNodeExtension: @@ -31,13 +31,13 @@ AnimationNodeExtension .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`_process_animation_node`\ (\ playback_info\: :ref:`PackedFloat64Array`, test_only\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_remaining_time`\ (\ node_info\: :ref:`PackedFloat32Array`, break_loop\: :ref:`bool`\ ) |static| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_looping`\ (\ node_info\: :ref:`PackedFloat32Array`\ ) |static| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`_process_animation_node`\ (\ playback_info\: :ref:`PackedFloat64Array`, test_only\: :ref:`bool`\ ) |virtual| |required| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_remaining_time`\ (\ node_info\: :ref:`PackedFloat32Array`, break_loop\: :ref:`bool`\ ) |static| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_looping`\ (\ node_info\: :ref:`PackedFloat32Array`\ ) |static| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ AnimationNodeExtension .. rst-class:: classref-method -:ref:`PackedFloat32Array` **_process_animation_node**\ (\ playback_info\: :ref:`PackedFloat64Array`, test_only\: :ref:`bool`\ ) |virtual| :ref:`🔗` +:ref:`PackedFloat32Array` **_process_animation_node**\ (\ playback_info\: :ref:`PackedFloat64Array`, test_only\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 方法 :ref:`AnimationNode._process()` 的某个版本是供自定义节点覆盖所用。它会返回一个带有已处理过的动画数据的\ :ref:`PackedFloat32Array`\ 。 @@ -85,6 +85,7 @@ AnimationNodeExtension 如果给定的 ``node_info`` 对应的动画正在循环，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeoneshot.rst b/classes/zh_CN/class_animationnodeoneshot.rst index 21dc5c19b2..7ffc3eae04 100644 --- a/classes/zh_CN/class_animationnodeoneshot.rst +++ b/classes/zh_CN/class_animationnodeoneshot.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeOneShot.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeOneShot.xml. .. _class_AnimationNodeOneShot: @@ -32,22 +32,22 @@ AnimationNodeOneShot animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_FIRE) # 替代语法（与上述结果相同）。 animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_FIRE - + # 中止连接到 “shot” 端口的子动画。 animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_ABORT) # 替代语法（与上述结果相同）。 animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_FADE_OUT - + # 使用淡出的方法中止连接到 “shot”端口的子动画。 animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_FADE_OUT) # 替代语法（与上述结果相同）。 animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_FADE_OUT - + # 获取当前状态（只读）。 animation_tree.get("parameters/OneShot/active")) # 替代语法（与上述结果相同）。 animation_tree["parameters/OneShot/active"] - + # 获取当前内部状态（只读）。 animation_tree.get("parameters/OneShot/internal_active") # 替代语法（与上述结果相同）。 @@ -57,16 +57,16 @@ AnimationNodeOneShot // 播放连接到 “shot” 端口的子动画。 animationTree.Set("parameters/OneShot/request", (int)AnimationNodeOneShot.OneShotRequest.Fire); - + // 中止连接到 “shot” 端口的子动画。 animationTree.Set("parameters/OneShot/request", (int)AnimationNodeOneShot.OneShotRequest.Abort); - + // 使用淡出的方法中止连接到 “shot”端口的子动画。 animationTree.Set("parameters/OneShot/request", (int)AnimationNodeOneShot.OneShotRequest.FadeOut); - + // 获取当前状态（只读）。 animationTree.Get("parameters/OneShot/active"); - + // 获取当前内部状态（只读）。 animationTree.Get("parameters/OneShot/internal_active"); @@ -291,7 +291,7 @@ enum **MixMode**: :ref:`🔗` 淡入的持续时间。例如有一个长度为 5 秒的动画，如果将该属性设置为 ``1.0``\ ，就会生成一个从动画的 0 秒处开始、1 秒处结束的交叉渐变。 -\ **注意：**\ **AnimationNodeOneShot** 是在淡入淡出结束后转换当前状态的。将 :ref:`AnimationNodeOutput` 视为最上游时，\ :ref:`fadein_time` 会根据下游增量进行缩放。例如将该属性设置为 ``1.0`` 时，如果下游连接的是一个取值为 ``2.0`` 的 :ref:`AnimationNodeTimeScale`\ ，那么实际的处理时间就是 0.5 秒。 +\ **注意：**\ **AnimationNodeOneShot** 是在淡入淡出结束后转换当前状态的。 .. rst-class:: classref-item-separator @@ -327,7 +327,7 @@ enum **MixMode**: :ref:`🔗` 淡出的持续时间。例如有一个长度为 5 秒的动画，如果将该属性设置为 ``1.0``\ ，就会生成一个从动画的 4 秒处开始、5 秒处结束的交叉渐变。 -\ **注意：**\ **AnimationNodeOneShot** 是在淡入淡出结束后转换当前状态的。将 :ref:`AnimationNodeOutput` 视为最上游时，\ :ref:`fadein_time` 会根据下游增量进行缩放。例如将该属性设置为 ``1.0`` 时，如果下游连接的是一个取值为 ``2.0`` 的 :ref:`AnimationNodeTimeScale`\ ，那么实际的处理时间就是 0.5 秒。 +\ **注意：**\ **AnimationNodeOneShot** 是在淡入淡出结束后转换当前状态的。 .. rst-class:: classref-item-separator @@ -347,6 +347,7 @@ enum **MixMode**: :ref:`🔗` 混合类型。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodeoutput.rst b/classes/zh_CN/class_animationnodeoutput.rst index 7ce3103b03..7f4792aba1 100644 --- a/classes/zh_CN/class_animationnodeoutput.rst +++ b/classes/zh_CN/class_animationnodeoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeOutput.xml. .. _class_AnimationNodeOutput: @@ -33,6 +33,7 @@ AnimationNodeOutput - `第三人称射击（TPS）演示 `__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodestatemachine.rst b/classes/zh_CN/class_animationnodestatemachine.rst index 66b81bf3a9..47ace89c8f 100644 --- a/classes/zh_CN/class_animationnodestatemachine.rst +++ b/classes/zh_CN/class_animationnodestatemachine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeStateMachine.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeStateMachine.xml. .. _class_AnimationNodeStateMachine: @@ -76,6 +76,8 @@ AnimationNodeStateMachine +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_node_list`\ (\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_node_name`\ (\ node\: :ref:`AnimationNode`\ ) |const| | +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | @@ -261,6 +263,18 @@ enum **StateMachineType**: :ref:`🔗`\[:ref:`StringName`\] **get_node_list**\ (\ ) |const| :ref:`🔗` + +返回包含状态机中所有动画节点名称的列表。 + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationNodeStateMachine_method_get_node_name: .. rst-class:: classref-method @@ -438,6 +452,7 @@ enum **StateMachineType**: :ref:`🔗`\ ) :ref:`🔗` + +``state`` 播放完毕时发出。如果 ``state`` 是设置为编组模式的状态机，则其信号会以其名称作为前缀传递。 + +如果存在交叉淡入淡出，则它将在 :ref:`get_fading_from_node()` 动画的影响不再存在时触发。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationNodeStateMachinePlayback_signal_state_started: + +.. rst-class:: classref-signal + +**state_started**\ (\ state\: :ref:`StringName`\ ) :ref:`🔗` + +当 ``state`` 开始播放时发出。如果 ``state`` 是一个设置为编组模式的状态机，则其信号将以其名称作为前缀传递。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 方法说明 -------- @@ -221,6 +252,7 @@ AnimationNodeStateMachinePlayback 如果 ``reset_on_teleport`` 为 ``true``\ ，当行进导致传送时，该动画将从头开始播放。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodestatemachinetransition.rst b/classes/zh_CN/class_animationnodestatemachinetransition.rst index 8f63489085..3f083f80cf 100644 --- a/classes/zh_CN/class_animationnodestatemachinetransition.rst +++ b/classes/zh_CN/class_animationnodestatemachinetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeStateMachineTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeStateMachineTransition.xml. .. _class_AnimationNodeStateMachineTransition: @@ -322,6 +322,7 @@ enum **AdvanceMode**: :ref:`🔗` 是在淡入淡出结束后转换当前状态的。只能根据主动画推断精确的剩余时间。将 :ref:`AnimationNodeOutput` 视为最上游时，\ :ref:`xfade_time` 不会根据下游增量进行缩放。另见 :ref:`AnimationNodeOneShot.fadeout_time`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodesub2.rst b/classes/zh_CN/class_animationnodesub2.rst index a0249832ff..1a22690d59 100644 --- a/classes/zh_CN/class_animationnodesub2.rst +++ b/classes/zh_CN/class_animationnodesub2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeSub2.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeSub2.xml. .. _class_AnimationNodeSub2: @@ -35,6 +35,7 @@ AnimationNodeSub2 - :doc:`AnimationTree <../tutorials/animation/animation_tree>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodesync.rst b/classes/zh_CN/class_animationnodesync.rst index f577b4ccc1..abdffa4be1 100644 --- a/classes/zh_CN/class_animationnodesync.rst +++ b/classes/zh_CN/class_animationnodesync.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeSync.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeSync.xml. .. _class_AnimationNodeSync: @@ -67,6 +67,7 @@ AnimationNodeSync 如果为 ``true``\ ，则强制混合动画以前进帧。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodetimescale.rst b/classes/zh_CN/class_animationnodetimescale.rst index 3f2e98c7df..2400fcb467 100644 --- a/classes/zh_CN/class_animationnodetimescale.rst +++ b/classes/zh_CN/class_animationnodetimescale.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeTimeScale.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTimeScale.xml. .. _class_AnimationNodeTimeScale: @@ -31,6 +31,7 @@ AnimationNodeTimeScale - `3D 平台跳跃演示 `__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodetimeseek.rst b/classes/zh_CN/class_animationnodetimeseek.rst index 853eb791e0..4dd8505e94 100644 --- a/classes/zh_CN/class_animationnodetimeseek.rst +++ b/classes/zh_CN/class_animationnodetimeseek.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeTimeSeek.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTimeSeek.xml. .. _class_AnimationNodeTimeSeek: @@ -32,7 +32,7 @@ AnimationNodeTimeSeek animation_tree.set("parameters/TimeSeek/seek_request", 0.0) # 替代语法（与上述结果相同）。 animation_tree["parameters/TimeSeek/seek_request"] = 0.0 - + # 从 12 秒的时间戳开始播放子动画。 animation_tree.set("parameters/TimeSeek/seek_request", 12.0) # 替代语法（与上述结果相同）。 @@ -42,7 +42,7 @@ AnimationNodeTimeSeek // 从开始处播放子动画。 animationTree.Set("parameters/TimeSeek/seek_request", 0.0); - + // 从 12 秒的时间戳开始播放子动画。 animationTree.Set("parameters/TimeSeek/seek_request", 12.0); @@ -90,6 +90,7 @@ AnimationNodeTimeSeek 如果为 ``true``\ ，某些旨在控制快进快退之间的帧的进程（例如计算根动态或寻找最接近的离散帧）将被执行。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationnodetransition.rst b/classes/zh_CN/class_animationnodetransition.rst index c435258aa8..6a2e91c96c 100644 --- a/classes/zh_CN/class_animationnodetransition.rst +++ b/classes/zh_CN/class_animationnodetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationNodeTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTransition.xml. .. _class_AnimationNodeTransition: @@ -34,12 +34,12 @@ AnimationNodeTransition animation_tree.set("parameters/Transition/transition_request", "state_2") # 替代语法（与上述结果相同）。 animation_tree["parameters/Transition/transition_request"] = "state_2" - + # 获取当前状态名称（只读）。 animation_tree.get("parameters/Transition/current_state") # 替代语法（与上述结果相同）。 animation_tree["parameters/Transition/current_state"] - + # 获取当前状态索引（只读）。 animation_tree.get("parameters/Transition/current_index")) # 替代语法（与上述结果相同）。 @@ -49,10 +49,10 @@ AnimationNodeTransition // 播放连接到 “state_2” 端口的子动画。 animationTree.Set("parameters/Transition/transition_request", "state_2"); - + // 获取当前状态名称（只读）。 animationTree.Get("parameters/Transition/current_state"); - + // 获取当前状态索引（只读）。 animationTree.Get("parameters/Transition/current_index"); @@ -262,6 +262,7 @@ AnimationNodeTransition 如果为 ``true``\ ，则目标动画在动画过渡时重新启动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationplayer.rst b/classes/zh_CN/class_animationplayer.rst index 497172ed35..f577320c01 100644 --- a/classes/zh_CN/class_animationplayer.rst +++ b/classes/zh_CN/class_animationplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationPlayer.xml. .. _class_AnimationPlayer: @@ -787,7 +787,7 @@ enum **AnimationMethodCallMode**: :ref:`🔗` -如果设置了区域则重置当前区域。 +重置当前区域。如果尚未设置区域则不做任何事情。 .. rst-class:: classref-item-separator @@ -902,6 +902,7 @@ enum **AnimationMethodCallMode**: :ref:`🔗` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_animationtree.rst b/classes/zh_CN/class_animationtree.rst index ca2ebb5d9b..a63369cec1 100644 --- a/classes/zh_CN/class_animationtree.rst +++ b/classes/zh_CN/class_animationtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AnimationTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationTree.xml. .. _class_AnimationTree: @@ -218,6 +218,7 @@ enum **AnimationProcessCallback**: :ref:`🔗` - |void| **set_angular_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_angular_damp_space_override_mode**\ (\ ) -此区域内的角阻尼计算的覆盖模式。有关可能的值，请参阅 :ref:`SpaceOverride`\ 。 +此区域内的角阻尼计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -474,7 +474,7 @@ enum **SpaceOverride**: :ref:`🔗` - |void| **set_gravity_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_gravity_space_override_mode**\ (\ ) -该区域内重力计算的覆盖模式。有关可能的值，请参阅 :ref:`SpaceOverride`\ 。 +该区域内重力计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -510,7 +510,7 @@ enum **SpaceOverride**: :ref:`🔗` - |void| **set_linear_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_linear_damp_space_override_mode**\ (\ ) -该区域内线性阻尼计算的覆盖模式。可取的值见 :ref:`SpaceOverride`\ 。 +该区域内线性阻尼计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -655,6 +655,7 @@ enum **SpaceOverride**: :ref:`🔗` 参数 ``body`` 可以是 :ref:`PhysicsBody2D` 实例，也可以是 :ref:`TileMap` 实例。TileMap 虽然不是物理物体，但会把图块的碰撞形状注册为虚拟物理物体。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_area3d.rst b/classes/zh_CN/class_area3d.rst index 154bcae678..59c4babd82 100644 --- a/classes/zh_CN/class_area3d.rst +++ b/classes/zh_CN/class_area3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Area3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Area3D.xml. .. _class_Area3D: @@ -169,7 +169,7 @@ Area3D var other_shape_owner = area.shape_find_owner( area_shape_index) var other_shape_node = area.shape_owner_get_owner(other_shape_owner) - + var local_shape_owner = shape_find_owner(local_shape_index) var local_shape_node = shape_owner_get_owner(local_shape_owner) @@ -236,7 +236,7 @@ Area3D var body_shape_owner = body.shape_find_owner(body_shape_index) var body_shape_node = body.shape_owner_get_owner(body_shape_owner) - + var local_shape_owner = shape_find_owner(local_shape_index) var local_shape_node = shape_owner_get_owner(local_shape_owner) @@ -350,7 +350,7 @@ enum **SpaceOverride**: :ref:`🔗` - |void| **set_angular_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_angular_damp_space_override_mode**\ (\ ) -此区域内的角阻尼计算的覆盖模式。有关可能的值，请参阅 :ref:`SpaceOverride`\ 。 +此区域内的角阻尼计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -488,7 +488,7 @@ enum **SpaceOverride**: :ref:`🔗` - |void| **set_gravity_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_gravity_space_override_mode**\ (\ ) -该区域内重力计算的覆盖模式。有关可能的值，请参阅 :ref:`SpaceOverride`\ 。 +该区域内重力计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -524,7 +524,7 @@ enum **SpaceOverride**: :ref:`🔗` - |void| **set_linear_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) - :ref:`SpaceOverride` **get_linear_damp_space_override_mode**\ (\ ) -该区域内线性阻尼计算的覆盖模式。可取的值见 :ref:`SpaceOverride`\ 。 +该区域内线性阻尼计算的覆盖模式。 .. rst-class:: classref-item-separator @@ -794,6 +794,7 @@ enum **SpaceOverride**: :ref:`🔗` 参数 ``body`` 可以是 :ref:`PhysicsBody3D` 实例，也可以是 :ref:`GridMap` 实例。GridMap 虽然不是物理物体，但会把图块的碰撞形状注册为虚拟物理物体。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_array.rst b/classes/zh_CN/class_array.rst index 4c0dee7bca..261f6760f0 100644 --- a/classes/zh_CN/class_array.rst +++ b/classes/zh_CN/class_array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Array.xml. .. _class_Array: @@ -28,7 +28,7 @@ Array print(array[0]) # 输出“第一” print(array[2]) # 输出 3 print(array[-1]) # 输出“最后” - + array[1] = "第二" print(array[1]) # 输出“第二” print(array[-3]) # 输出“第二” @@ -39,7 +39,7 @@ Array GD.Print(array[0]); // 输出“开头” GD.Print(array[2]); // 输出 3 GD.Print(array[^1]); // 输出“最后” - + array[2] = "第二"; GD.Print(array[1]); // 输出“第二” GD.Print(array[^3]); // 输出“第二” @@ -123,6 +123,8 @@ Array +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`duplicate_deep`\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase`\ (\ value\: :ref:`Variant`\ ) | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`Variant`\ ) | @@ -267,10 +269,10 @@ Array class_name Sword extends Node - + class Stats: pass - + func _ready(): var a = Array([], TYPE_INT, "", null) # Array[int] var b = Array([], TYPE_OBJECT, "Node", null) # Array[Node] @@ -285,7 +287,7 @@ Array var numbers: Array[float] = [] var children: Array[Node] = [$Node, $Sprite2D, $RigidBody3D] - + var integers: Array[int] = [0.2, 4.5, -2.0] print(integers) # 输出 [0, 4, -2] @@ -425,13 +427,13 @@ Array func greater_than_5(number): return number > 5 - + func _ready(): print([6, 10, 6].all(greater_than_5)) # 输出 true （3/3 元素被评估为真）。 print([4, 10, 4].all(greater_than_5)) # 输出 false （1/3 元素被评估为真）。 print([4, 4, 4].all(greater_than_5)) # 输出 false （0/3 元素被评估为真）。 print([].all(greater_than_5)) # 输出 true （0/0 元素被评估为真）。 - + # 与上面的第一行相同，但使用 lambda 函数。 print([6, 10, 6].all(func(element): return element > 5)) # 输出 true @@ -441,7 +443,7 @@ Array { return number > 5; } - + public override void _Ready() { // 输出 True （3/3 元素被评估为真）。 @@ -452,7 +454,7 @@ Array GD.Print(new Godot.Collections.Array>int< { 4, 4, 4 }.All(GreaterThan5)); // 输出 True （0/0 元素被评估为真）。 GD.Print(new Godot.Collections.Array>int< { }.All(GreaterThan5)); - + // 与上面的第一行相同，但使用 lambda 函数。 GD.Print(new Godot.Collections.Array>int< { 6, 10, 6 }.All(element => element > 5)); // 输出 True } @@ -483,13 +485,13 @@ Array func greater_than_5(number): return number > 5 - + func _ready(): print([6, 10, 6].any(greater_than_5)) # 输出 true （3 个元素被评估为真）。 print([4, 10, 4].any(greater_than_5)) #输出 true （1 个元素被评估为真）。 print([4, 4, 4].any(greater_than_5)) # 输出 false （0 个元素被评估为真）。 print([].any(greater_than_5)) # 输出 false （0 个元素被评估为真）。 - + # 与上面的第一行相同，但使用 lambda 函数。 print([6, 10, 6].any(func(number): return number > 5)) # 输出 true @@ -574,10 +576,10 @@ Array var numbers = [2, 4, 8, 10] var idx = numbers.bsearch(7) - + numbers.insert(idx, 7) print(numbers) # 输出 [2, 4, 7, 8, 10] - + var fruits = ["Apple", "Lemon", "Lemon", "Orange"] print(fruits.bsearch("Lemon", true)) # 输出 1，位于第一个 "Lemon"。 print(fruits.bsearch("Lemon", false)) # 输出 3，位于 "Orange"。 @@ -606,18 +608,18 @@ Array if a[1] < b[1]: return true return false - + func _ready(): var my_items = [["Tomato", 2], ["Kiwi", 5], ["Rice", 9]] - + var apple = ["Apple", 5] # "Apple" 被插入在 "Kiwi" 之前。 my_items.insert(my_items.bsearch_custom(apple, sort_by_amount, true), apple) - + var banana = ["Banana", 5] # "Banana" 被插入在 "Kiwi" 之后。 my_items.insert(my_items.bsearch_custom(banana, sort_by_amount, false), banana) - + # 输出 [["Tomato", 2], ["Apple", 5], ["Kiwi", 5], ["Banana", 5], ["Rice", 9]] print(my_items) @@ -661,9 +663,23 @@ Array 返回数组的新副本。 -默认情况下返回的是\ **浅拷贝**\ ：嵌套的 **Array** 和 :ref:`Dictionary` 元素与原数组共享。对这些元素的修改会影响另一个数组。 +默认情况下返回的是\ **浅拷贝**\ ：嵌套的 **Array**\ 、\ :ref:`Dictionary` 和 :ref:`Resource` 元素与原数组共享。对这些元素的修改会影响另一个数组。 -如果 ``deep`` 为 ``true`` 则会返回\ **深拷贝**\ ：嵌套的数组和字典也会进行（递归的）复制。 +如果 ``deep`` 为 ``true`` 则会返回\ **深拷贝**\ ：嵌套的数组和字典也会进行（递归的）复制。不过 :ref:`Resource` 仍然是和原数组共享的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Array_method_duplicate_deep: + +.. rst-class:: classref-method + +:ref:`Array` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| :ref:`🔗` + +深度复制该数组，类似 :ref:`duplicate()`\ ``(true)``\ ，但能够额外控制子资源的处理方式。 + +\ ``deep_subresources_mode`` 必须是 :ref:`DeepDuplicateMode` 中的一个值。默认只会（递归）复制内部资源。 .. rst-class:: classref-item-separator @@ -734,10 +750,10 @@ Array func is_even(number): return number % 2 == 0 - + func _ready(): print([1, 4, 5, 8].filter(is_even)) # 输出 [4, 8] - + # 与上面相同，但使用 lambda 函数。 print([1, 4, 5, 8].filter(func(number): return number % 2 == 0)) @@ -782,7 +798,7 @@ Array func is_even(number): return number % 2 == 0 - + func _ready(): print([1, 3, 4, 7].find_custom(is_even.bind())) # 输出 2 @@ -812,7 +828,9 @@ Array :ref:`Variant` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中给定索引 ``index`` 位置的元素。这与使用 ``[]`` 运算符（\ ``array[index]``\ ）是一样的。 +返回数组中索引为 ``index`` 的元素。如果 ``index`` 越界或为负数，则该方法失败并返回 ``null``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -916,7 +934,7 @@ Array :ref:`int` **insert**\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) :ref:`🔗` -在数组中给定索引（\ ``position``\ ）处插入新元素（\ ``value``\ ）。\ ``position`` 应介于 ``0`` 和数组的 :ref:`size()` 之间。 +在数组中给定索引（\ ``position``\ ）处插入新元素（\ ``value``\ ）。\ ``position`` 应介于 ``0`` 和数组的 :ref:`size()` 之间。如果为负数，则认为 ``position`` 为相对于数组结尾的索引。 如果成功，则返回 :ref:`@GlobalScope.OK`\ ；如果该方法失败，则返回其他 :ref:`Error` 常量之一。 @@ -1011,10 +1029,10 @@ Array func double(number): return number * 2 - + func _ready(): print([1, 2, 3].map(double)) # 输出 [2, 4, 6] - + # 与上面相同，但使用 lambda 函数。 print([1, 2, 3].map(func(element): return element * 2)) @@ -1087,7 +1105,7 @@ Array 移除并返回数组中位于 ``position`` 索引处的元素。如果 ``position`` 为负数，则认为是相对于该数组末尾的值。如果数组为空，则返回 ``null``\ ；如果 ``position`` 超出范围，还会生成错误消息。 -\ **注意：**\ 该方法将 ``position`` 之后每个元素的索引向后移动，这可能会产生明显的性能成本，尤其是在较大的数组上。 +\ **注意：**\ 该方法将 ``position`` 之后每个元素的索引向前移动，这可能会产生明显的性能成本，尤其是在较大的数组上。 .. rst-class:: classref-item-separator @@ -1159,11 +1177,11 @@ Array func sum(accum, number): return accum + number - + func _ready(): print([1, 2, 3].reduce(sum, 0)) # 输出 6 print([1, 2, 3].reduce(sum, 10)) # 输出 16 - + # 与上面相同，但是使用 lambda 函数。 print([1, 2, 3].reduce(func(accum, number): return accum + number, 10)) @@ -1173,10 +1191,10 @@ Array func _ready(): var arr = [Vector2i(5, 0), Vector2i(3, 4), Vector2i(1, 2)] - + var longest_vec = arr.reduce(func(max, vec): return vec if is_length_greater(vec, max) else max) print(longest_vec) # 输出 (3, 4) - + func is_length_greater(a, b): return a.length() > b.length() @@ -1186,7 +1204,7 @@ Array func is_even(number): return number % 2 == 0 - + func _ready(): var arr = [1, 2, 3, 4, 5] # 当前元素为偶数则增加计数器，否则保持计数不变。 @@ -1205,11 +1223,11 @@ Array |void| **remove_at**\ (\ position\: :ref:`int`\ ) :ref:`🔗` -从数组中移除指定索引（\ ``position``\ ）处的元素。如果索引超出范围，则该方法失败。 +从数组中移除指定索引（\ ``position``\ ）处的元素。如果索引超出范围，则该方法失败。如果为负数，则认为 ``position`` 为相对于数组结尾的索引。 如果需要返回被移除的元素，请使用 :ref:`pop_at()`\ 。要按值移除元素，请改用 :ref:`erase()`\ 。 -\ **注意：**\ 该方法将 ``position`` 之后每个元素的索引向后移，这可能会产生明显的性能成本，尤其是在较大的数组上。 +\ **注意：**\ 该方法将 ``position`` 之后每个元素的索引向前移动，这可能会产生明显的性能成本，尤其是在较大的数组上。 \ **注意：**\ ``position`` 不能为负数。要移除相对于数组末尾的元素，请使用 ``arr.remove_at(arr.size() - (i + 1))``\ 。要从数组中移除最后一个元素，请使用 ``arr.resize(arr.size() - 1)``\ 。 @@ -1225,7 +1243,7 @@ Array 将数组的元素数设置为 ``size``\ 。如果 ``size`` 小于数组的当前大小，则移除末尾的元素。如果 ``size`` 大于数组的当前大小，则添加新的默认元素（通常为 ``null``\ ），具体取决于数组的类型。 -如果成功，则返回 :ref:`@GlobalScope.OK`\ ；如果该方法失败，则返回其他 :ref:`Error` 常量之一。 +如果成功则返回 :ref:`@GlobalScope.OK`\ ，如果该方法失败则返回其他 :ref:`Error` 常量之一：数组只读时为 :ref:`@GlobalScope.ERR_LOCKED`\ ，大小为负数时为 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败时为 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 查看数组调整后的实际大小。 \ **注意：**\ 调用该方法一次并分配新值，要比为每个新元素调用 :ref:`append()` 更快。 @@ -1319,16 +1337,16 @@ Array 如果 ``step`` 为负数，则该方法反向遍历数组，返回按反向顺序排列的切片数组。要使其起作用，\ ``begin`` 必须大于 ``end``\ 。 -如果 ``deep`` 为 ``true``\ ，则切片数组中所有嵌套的 **Array** 和 :ref:`Dictionary` 元素都将从原始元素中递归复制。另见 :ref:`duplicate()`)。 +如果 ``deep`` 为 ``true``\ ，则切片数组中所有嵌套的 **Array** 和 :ref:`Dictionary` 元素都将从原始元素中递归复制。另见 :ref:`duplicate()`\ 。 :: var letters = ["A", "B", "C", "D", "E", "F"] - + print(letters.slice(0, 2)) # 输出 ["A", "B"] print(letters.slice(2, -2)) # 输出 ["C", "D"] print(letters.slice(-2, 6)) # 输出 ["E", "F"] - + print(letters.slice(0, 6, 2)) # 输出 ["A", "C", "E"] print(letters.slice(4, 1, -1)) # 输出 ["E", "D", "C"] @@ -1383,12 +1401,12 @@ Array if a[1] < b[1]: return true return false - + func _ready(): var my_items = [["Tomato", 5], ["Apple", 9], ["Rice", 4]] my_items.sort_custom(sort_ascending) print(my_items) # 输出 [["Rice", 4], ["Tomato", 5], ["Apple", 9]] - + # 使用 lambda 函数按降序排序。 my_items.sort_custom(func(a, b): return a[0] > b[0]) print(my_items) # 输出 [["Apple", 9], ["Tomato", 5], ["Rice", 4]] @@ -1537,6 +1555,7 @@ Array 返回指定 ``index`` 处的 :ref:`Variant` 元素。数组从索引 0 开始。如果 ``index`` 大于或等于 ``0``\ ，则从数组开头开始获取元素。如果 ``index`` 为负值，则从末尾开始获取元素。越界访问数组将导致运行时错误，从编辑器中运行时会暂停项目执行。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_arraymesh.rst b/classes/zh_CN/class_arraymesh.rst index 484d3ea620..e4ea0125de 100644 --- a/classes/zh_CN/class_arraymesh.rst +++ b/classes/zh_CN/class_arraymesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ArrayMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ArrayMesh.xml. .. _class_ArrayMesh: @@ -32,13 +32,13 @@ ArrayMesh vertices.push_back(Vector3(0, 1, 0)) vertices.push_back(Vector3(1, 0, 0)) vertices.push_back(Vector3(0, 0, 1)) - + # 初始化 ArrayMesh。 var arr_mesh = ArrayMesh.new() var arrays = [] arrays.resize(Mesh.ARRAY_MAX) arrays[Mesh.ARRAY_VERTEX] = vertices - + # 创建 Mesh。 arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays) var m = MeshInstance3D.new() @@ -52,13 +52,13 @@ ArrayMesh new Vector3(1, 0, 0), new Vector3(0, 0, 1), ]; - + // 初始化 ArrayMesh。 var arrMesh = new ArrayMesh(); Godot.Collections.Array arrays = []; arrays.Resize((int)Mesh.ArrayType.Max); arrays[(int)Mesh.ArrayType.Vertex] = vertices; - + // 创建 Mesh。 arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, arrays); var m = new MeshInstance3D(); @@ -165,7 +165,7 @@ ArrayMesh - |void| **set_blend_shape_mode**\ (\ value\: :ref:`BlendShapeMode`\ ) - :ref:`BlendShapeMode` **get_blend_shape_mode**\ (\ ) -将混合形状模式设置为 :ref:`BlendShapeMode` 之一。 +混合形状模式。 .. rst-class:: classref-item-separator @@ -467,6 +467,7 @@ ArrayMesh 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_arrayoccluder3d.rst b/classes/zh_CN/class_arrayoccluder3d.rst index b687aa5423..46bc19d76d 100644 --- a/classes/zh_CN/class_arrayoccluder3d.rst +++ b/classes/zh_CN/class_arrayoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ArrayOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ArrayOccluder3D.xml. .. _class_ArrayOccluder3D: @@ -121,6 +121,7 @@ ArrayOccluder3D 设置 :ref:`indices` 和 :ref:`vertices`\ ，同时会在两个值都被设置后仅更新一次最终遮挡物。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_aspectratiocontainer.rst b/classes/zh_CN/class_aspectratiocontainer.rst index 618700a579..15575fb555 100644 --- a/classes/zh_CN/class_aspectratiocontainer.rst +++ b/classes/zh_CN/class_aspectratiocontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AspectRatioContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AspectRatioContainer.xml. .. _class_AspectRatioContainer: @@ -203,6 +203,7 @@ enum **AlignmentMode**: :ref:`🔗` 用来对齐子控件的拉伸模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_astar2d.rst b/classes/zh_CN/class_astar2d.rst index d5cbf3b4b4..753a443ebb 100644 --- a/classes/zh_CN/class_astar2d.rst +++ b/classes/zh_CN/class_astar2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AStar2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStar2D.xml. .. _class_AStar2D: @@ -23,6 +23,25 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 有关如何使用该类的更详尽的解释，请参阅 :ref:`AStar3D`\ 。\ **AStar2D** 是 :ref:`AStar3D` 的包装器，它强制执行 2D 坐标。 +.. rst-class:: classref-introduction-group + +教程 +---- + +- `AStarGrid2D 的网格导航演示 `__ + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`neighbor_filter_enabled` | ``false`` | + +-------------------------+--------------------------------------------------------------------------------+-----------+ + .. rst-class:: classref-reftable-group 方法 @@ -36,6 +55,8 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`int`, end_id\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_filter_neighbor`\ (\ from_id\: :ref:`int`, neighbor_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_point`\ (\ id\: :ref:`int`, position\: :ref:`Vector2`, weight_scale\: :ref:`float` = 1.0\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_points_connected`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| | @@ -89,6 +110,28 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 .. rst-class:: classref-descriptions-group +属性说明 +-------- + +.. _class_AStar2D_property_neighbor_filter_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **neighbor_filter_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_neighbor_filter_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_neighbor_filter_enabled**\ (\ ) + +如果为 ``true``\ ，则启用通过 :ref:`_filter_neighbor()` 过滤邻接点。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 方法说明 -------- @@ -120,6 +163,20 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 ---- +.. _class_AStar2D_private_method__filter_neighbor: + +.. rst-class:: classref-method + +:ref:`bool` **_filter_neighbor**\ (\ from_id\: :ref:`int`, neighbor_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +进入邻接处理且 :ref:`neighbor_filter_enabled` 为 ``true`` 时调用。如果返回 ``true``\ ，则不会处理对应的点。 + +请注意，这个函数在默认的 **AStar2D** 类中是隐藏的。 + +.. rst-class:: classref-item-separator + +---- + .. _class_AStar2D_method_add_point: .. rst-class:: classref-method @@ -301,12 +358,12 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 astar.add_point(2, Vector2(0, 1), 1) # 默认权重为 1 astar.add_point(3, Vector2(1, 1)) astar.add_point(4, Vector2(2, 0)) - + astar.connect_points(1, 2, false) astar.connect_points(2, 3, false) astar.connect_points(4, 3, false) astar.connect_points(1, 4, false) - + var res = astar.get_id_path(1, 3) # 返回 [1, 2, 3] .. code-tab:: csharp @@ -316,7 +373,7 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 astar.AddPoint(2, new Vector2(0, 1), 1); // 默认权重为 1 astar.AddPoint(3, new Vector2(1, 1)); astar.AddPoint(4, new Vector2(2, 0)); - + astar.ConnectPoints(1, 2, false); astar.ConnectPoints(2, 3, false); astar.ConnectPoints(4, 3, false); @@ -361,10 +418,10 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 astar.add_point(2, Vector2(0, 1)) astar.add_point(3, Vector2(1, 1)) astar.add_point(4, Vector2(2, 0)) - + astar.connect_points(1, 2, true) astar.connect_points(1, 3, true) - + var neighbors = astar.get_point_connections(1) # 返回 [2, 3] .. code-tab:: csharp @@ -374,10 +431,10 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 astar.AddPoint(2, new Vector2(0, 1)); astar.AddPoint(3, new Vector2(1, 1)); astar.AddPoint(4, new Vector2(2, 0)); - + astar.ConnectPoints(1, 2, true); astar.ConnectPoints(1, 3, true); - + long[] neighbors = astar.GetPointConnections(1); // 返回 [2, 3] @@ -416,13 +473,13 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 :ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` -返回一个数组，其中包含 AStar2D 在给定点之间找到的路径中的点。数组从路径的起点到终点进行排序。 +Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. -如果没有通往目标的有效路径并且 ``allow_partial_path`` 为 ``true``\ ，则会返回通往距离目标最近的可达点的路径。 +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. -\ **注意：**\ 该方法不是线程安全的。如果从 :ref:`Thread` 调用，它将返回一个空的 :ref:`PackedVector2Array` 并打印一条错误消息。 +\ **Note:** This method is not thread-safe; it can only be used from a single :ref:`Thread` at a given time. Consider using :ref:`Mutex` to ensure exclusive access to one thread to avoid race conditions. -另外，如果 ``allow_partial_path`` 为 ``true`` 并且 ``to_id`` 处于禁用状态，搜索耗时可能异常地大。 +Additionally, when ``allow_partial_path`` is ``true`` and ``to_id`` is disabled the search may take an unusually long time to finish. .. rst-class:: classref-item-separator @@ -494,7 +551,7 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 |void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) :ref:`🔗` -在内部为 ``num_nodes`` 个点预留空间。如果需要大批添加已知数量的点，例如网格上的点，则此函数很有用。新的容量必须大于或等于旧的容量。 +在内部预留 ``num_nodes`` 个点的空间。适用于需要一次性添加大量已知数量的点的情况，例如添加网格上的点。 .. rst-class:: classref-item-separator @@ -533,6 +590,7 @@ A\* 算法的一种实现，用于在 2D 空间中的连通图上找到两个顶 为给定的 ``id`` 的点设置 ``weight_scale``\ 。在确定从邻接点到这个点的一段路程的总成本时，\ ``weight_scale`` 要乘以 :ref:`_compute_cost()` 的结果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_astar3d.rst b/classes/zh_CN/class_astar3d.rst index 58e98e8c70..c8507d670c 100644 --- a/classes/zh_CN/class_astar3d.rst +++ b/classes/zh_CN/class_astar3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AStar3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStar3D.xml. .. _class_AStar3D: @@ -34,12 +34,12 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 class_name MyAStar3D extends AStar3D - + func _compute_cost(u, v): var u_pos = get_point_position(u) var v_pos = get_point_position(v) return abs(u_pos.x - v_pos.x) + abs(u_pos.y - v_pos.y) + abs(u_pos.z - v_pos.z) - + func _estimate_cost(u, v): var u_pos = get_point_position(u) var v_pos = get_point_position(v) @@ -48,7 +48,7 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 .. code-tab:: csharp using Godot; - + [GlobalClass] public partial class MyAStar3D : AStar3D { @@ -56,10 +56,10 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 { Vector3 fromPoint = GetPointPosition(fromId); Vector3 toPoint = GetPointPosition(toId); - + return Mathf.Abs(fromPoint.X - toPoint.X) + Mathf.Abs(fromPoint.Y - toPoint.Y) + Mathf.Abs(fromPoint.Z - toPoint.Z); } - + public override float _EstimateCost(long fromId, long toId) { Vector3 fromPoint = GetPointPosition(fromId); @@ -76,6 +76,18 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 .. rst-class:: classref-reftable-group +属性 +---- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`neighbor_filter_enabled` | ``false`` | + +-------------------------+--------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + 方法 ---- @@ -87,6 +99,8 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`int`, end_id\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_filter_neighbor`\ (\ from_id\: :ref:`int`, neighbor_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_point`\ (\ id\: :ref:`int`, position\: :ref:`Vector3`, weight_scale\: :ref:`float` = 1.0\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_points_connected`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| | @@ -140,6 +154,28 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 .. rst-class:: classref-descriptions-group +属性说明 +-------- + +.. _class_AStar3D_property_neighbor_filter_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **neighbor_filter_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_neighbor_filter_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_neighbor_filter_enabled**\ (\ ) + +如果为 ``true``\ ，则启用通过 :ref:`_filter_neighbor()` 过滤邻接点。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 方法说明 -------- @@ -171,6 +207,20 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 ---- +.. _class_AStar3D_private_method__filter_neighbor: + +.. rst-class:: classref-method + +:ref:`bool` **_filter_neighbor**\ (\ from_id\: :ref:`int`, neighbor_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +进入邻接处理且 :ref:`neighbor_filter_enabled` 为 ``true`` 时调用。如果返回 ``true``\ ，则不会处理对应的点。 + +请注意，这个函数在默认的 **AStar3D** 类中是隐藏的。 + +.. rst-class:: classref-item-separator + +---- + .. _class_AStar3D_method_add_point: .. rst-class:: classref-method @@ -352,12 +402,12 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 astar.add_point(2, Vector3(0, 1, 0), 1) # 默认权重为 1 astar.add_point(3, Vector3(1, 1, 0)) astar.add_point(4, Vector3(2, 0, 0)) - + astar.connect_points(1, 2, false) astar.connect_points(2, 3, false) astar.connect_points(4, 3, false) astar.connect_points(1, 4, false) - + var res = astar.get_id_path(1, 3) # 返回 [1, 2, 3] .. code-tab:: csharp @@ -411,10 +461,10 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 astar.add_point(2, Vector3(0, 1, 0)) astar.add_point(3, Vector3(1, 1, 0)) astar.add_point(4, Vector3(2, 0, 0)) - + astar.connect_points(1, 2, true) astar.connect_points(1, 3, true) - + var neighbors = astar.get_point_connections(1) # 返回 [2, 3] .. code-tab:: csharp @@ -426,7 +476,7 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 astar.AddPoint(4, new Vector3(2, 0, 0)); astar.ConnectPoints(1, 2, true); astar.ConnectPoints(1, 3, true); - + long[] neighbors = astar.GetPointConnections(1); // 返回 [2, 3] @@ -465,13 +515,13 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 :ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` -返回一个数组，其中包含 AStar3D 在给定点之间找到的路径中的点。数组从路径的起点到终点进行排序。 +Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. -如果没有通往目标的有效路径并且 ``allow_partial_path`` 为 ``true``\ ，则会返回通往距离目标最近的可达点的路径。 +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. -\ **注意：**\ 这种方法不是线程安全的。如果从 :ref:`Thread` 调用，它将返回一个空的 :ref:`PackedVector3Array`\ ，并打印一条错误消息。 +\ **Note:** This method is not thread-safe; it can only be used from a single :ref:`Thread` at a given time. Consider using :ref:`Mutex` to ensure exclusive access to one thread to avoid race conditions. -另外，如果 ``allow_partial_path`` 为 ``true`` 并且 ``to_id`` 处于禁用状态，搜索耗时可能异常地大。 +Additionally, when ``allow_partial_path`` is ``true`` and ``to_id`` is disabled the search may take an unusually long time to finish. .. rst-class:: classref-item-separator @@ -543,7 +593,7 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 |void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) :ref:`🔗` -该函数为 ``num_nodes`` 个点内部预留空间。如果一次添加了大量已知数量的点，例如网格上的点，则此函数很有用。新的容量必须大于或等于旧的容量。 +在内部预留 ``num_nodes`` 个点的空间。适用于需要一次性添加大量已知数量的点的情况，例如添加网格上的点。 .. rst-class:: classref-item-separator @@ -582,6 +632,7 @@ A\*（A 星）是一种用于寻路和图遍历的计算机算法，会根据一 为给定的 ``id`` 的点设置 ``weight_scale``\ 。在确定从邻接点到这个点的一段路程的总成本时，\ ``weight_scale`` 要乘以 :ref:`_compute_cost()` 的结果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_astargrid2d.rst b/classes/zh_CN/class_astargrid2d.rst index fd5fd7037c..12d952955f 100644 --- a/classes/zh_CN/class_astargrid2d.rst +++ b/classes/zh_CN/class_astargrid2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AStarGrid2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStarGrid2D.xml. .. _class_AStarGrid2D: @@ -48,6 +48,13 @@ A\* 的一种实现，用于寻找疏松 2D 网格中两点之间的最短路径 要从寻路网格中移除某个点，必须使用 :ref:`set_point_solid()` 将其设置为“实心”。 +.. rst-class:: classref-introduction-group + +教程 +---- + +- `AStarGrid2D 的网格导航演示 `__ + .. rst-class:: classref-reftable-group 属性 @@ -569,13 +576,13 @@ enum **CellShape**: :ref:`🔗` :ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` -返回一个数组，其中包含 **AStarGrid2D** 在给定点之间找到的路径上的点。数组从路径的起点到终点排序。 +Returns an array with the points that are in the path found by **AStarGrid2D** between the given points. The array is ordered from the starting point to the ending point of the path. -如果没有通往目标的有效路径并且 ``allow_partial_path`` 为 ``true``\ ，则会返回通往距离目标最近的可达点的路径。 +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. -\ **注意：**\ 该方法不是线程安全的。如果从 :ref:`Thread` 中调用它，它将返回一个空的 :ref:`PackedVector3Array` 并打印一条错误消息。 +\ **Note:** This method is not thread-safe; it can only be used from a single :ref:`Thread` at a given time. Consider using :ref:`Mutex` to ensure exclusive access to one thread to avoid race conditions. -另外，如果 ``allow_partial_path`` 为 ``true`` 并且 ``to_id`` 处于禁用状态，搜索耗时可能异常地大。 +Additionally, when ``allow_partial_path`` is ``true`` and ``to_id`` is solid the search may take an unusually long time to finish. .. rst-class:: classref-item-separator @@ -692,6 +699,7 @@ enum **CellShape**: :ref:`🔗` \ **注意：**\ 会清空所有点的数据（坚固以及权重比例）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_atlastexture.rst b/classes/zh_CN/class_atlastexture.rst index ad698906dc..460f84d108 100644 --- a/classes/zh_CN/class_atlastexture.rst +++ b/classes/zh_CN/class_atlastexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AtlasTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AtlasTexture.xml. .. _class_AtlasTexture: @@ -119,6 +119,7 @@ AtlasTexture 绘制 :ref:`atlas` 的区域。如果区域在某个方向上大小为 ``0``\ ，则该方向会使用 :ref:`atlas` 的大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiobuslayout.rst b/classes/zh_CN/class_audiobuslayout.rst index 912247f422..5f71d2c6a4 100644 --- a/classes/zh_CN/class_audiobuslayout.rst +++ b/classes/zh_CN/class_audiobuslayout.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioBusLayout.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioBusLayout.xml. .. _class_AudioBusLayout: @@ -22,6 +22,7 @@ AudioBusLayout 存储位置、静音、独奏、旁通、效果、效果位置、音量以及总线之间的连接。使用方法见 :ref:`AudioServer` 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffect.rst b/classes/zh_CN/class_audioeffect.rst index 4a9bb51173..47243575a3 100644 --- a/classes/zh_CN/class_audioeffect.rst +++ b/classes/zh_CN/class_audioeffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffect.xml. .. _class_AudioEffect: @@ -42,9 +42,9 @@ AudioEffect .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------+ - | :ref:`AudioEffectInstance` | :ref:`_instantiate`\ (\ ) |virtual| | - +-------------------------------------------------------+------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`AudioEffectInstance` | :ref:`_instantiate`\ (\ ) |virtual| |required| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -59,25 +59,26 @@ AudioEffect .. rst-class:: classref-method -:ref:`AudioEffectInstance` **_instantiate**\ (\ ) |virtual| :ref:`🔗` +:ref:`AudioEffectInstance` **_instantiate**\ (\ ) |virtual| |required| :ref:`🔗` 覆盖该方法以自定义新创建的 :ref:`AudioEffectInstance`\ ，它是在编辑器的音频面板中将该效果应用于总线时，或通过 :ref:`AudioServer.add_bus_effect()` 时创建的。 :: extends AudioEffect - + @export var strength = 4.0 - + func _instantiate(): var effect = CustomAudioEffectInstance.new() effect.base = self - + return effect \ **注意：**\ 建议在新实例中保留对原始 **AudioEffect** 的引用。根据实现，这允许效果实例在运行时监听更改并进行相应的修改。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectamplify.rst b/classes/zh_CN/class_audioeffectamplify.rst index 7364dd4c89..18e451762b 100644 --- a/classes/zh_CN/class_audioeffectamplify.rst +++ b/classes/zh_CN/class_audioeffectamplify.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectAmplify.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectAmplify.xml. .. _class_AudioEffectAmplify: @@ -84,6 +84,7 @@ AudioEffectAmplify \ **注意：**\ 该成员会帮助修改 :ref:`volume_db`\ 。返回的值等价于使用 :ref:`volume_db` 调用 :ref:`@GlobalScope.db_to_linear()` 的结果。设置该成员等价于将 :ref:`volume_db` 设置为使用新值调用 :ref:`@GlobalScope.linear_to_db()` 的结果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectbandlimitfilter.rst b/classes/zh_CN/class_audioeffectbandlimitfilter.rst index 9dfaca85d2..85214e6971 100644 --- a/classes/zh_CN/class_audioeffectbandlimitfilter.rst +++ b/classes/zh_CN/class_audioeffectbandlimitfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectBandLimitFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectBandLimitFilter.xml. .. _class_AudioEffectBandLimitFilter: @@ -29,6 +29,7 @@ AudioEffectBandLimitFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectbandpassfilter.rst b/classes/zh_CN/class_audioeffectbandpassfilter.rst index ff522fb8a5..e43569f8ca 100644 --- a/classes/zh_CN/class_audioeffectbandpassfilter.rst +++ b/classes/zh_CN/class_audioeffectbandpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectBandPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectBandPassFilter.xml. .. _class_AudioEffectBandPassFilter: @@ -29,6 +29,7 @@ AudioEffectBandPassFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectcapture.rst b/classes/zh_CN/class_audioeffectcapture.rst index ca68b401d6..7024aefd83 100644 --- a/classes/zh_CN/class_audioeffectcapture.rst +++ b/classes/zh_CN/class_audioeffectcapture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectCapture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectCapture.xml. .. _class_AudioEffectCapture: @@ -186,6 +186,7 @@ AudioEffectCapture 是一种 AudioEffect，可将所有音频帧从附加的音 返回从音频总线插入的音频帧的数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectchorus.rst b/classes/zh_CN/class_audioeffectchorus.rst index e35f377904..85f6a14a8d 100644 --- a/classes/zh_CN/class_audioeffectchorus.rst +++ b/classes/zh_CN/class_audioeffectchorus.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectChorus.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectChorus.xml. .. _class_AudioEffectChorus: @@ -764,6 +764,7 @@ AudioEffectChorus 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectcompressor.rst b/classes/zh_CN/class_audioeffectcompressor.rst index 0446e126c5..55b4e3db75 100644 --- a/classes/zh_CN/class_audioeffectcompressor.rst +++ b/classes/zh_CN/class_audioeffectcompressor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectCompressor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectCompressor.xml. .. _class_AudioEffectCompressor: @@ -25,7 +25,7 @@ AudioEffectCompressor 压缩器在混音中的用途很多。 -- 在主总线上压缩整个输出（虽然 :ref:`AudioEffectLimiter` 可能更好些）。 +- 在主总线上压缩整个输出（虽然 :ref:`AudioEffectHardLimiter` 可能更好些）。 - 在声音通道中，以确保它们听起来尽可能的平衡。 @@ -189,6 +189,7 @@ AudioEffectCompressor 超过该电平，压缩将应用于音频。值的范围可以从 -60 到 0。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectdelay.rst b/classes/zh_CN/class_audioeffectdelay.rst index ee1838f0a1..81a08cb4d0 100644 --- a/classes/zh_CN/class_audioeffectdelay.rst +++ b/classes/zh_CN/class_audioeffectdelay.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectDelay.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectDelay.xml. .. _class_AudioEffectDelay: @@ -293,6 +293,7 @@ AudioEffectDelay 第二拍的声像位置。取值范围为 -1（完全向左）到 1（完全向右）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectdistortion.rst b/classes/zh_CN/class_audioeffectdistortion.rst index 6875c06d59..7ed4b68419 100644 --- a/classes/zh_CN/class_audioeffectdistortion.rst +++ b/classes/zh_CN/class_audioeffectdistortion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectDistortion.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectDistortion.xml. .. _class_AudioEffectDistortion: @@ -202,6 +202,7 @@ enum **Mode**: :ref:`🔗` 在效果前增加或减少的音量，单位为分贝。取值范围从 -60 到 60。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecteq.rst b/classes/zh_CN/class_audioeffecteq.rst index 88dd6868fb..582a26c205 100644 --- a/classes/zh_CN/class_audioeffecteq.rst +++ b/classes/zh_CN/class_audioeffecteq.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectEQ.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ.xml. .. _class_AudioEffectEQ: @@ -90,6 +90,7 @@ AudioEffectEQ 可用于频率控制。用它来弥补音频中不足之处。Aud 设置指定索引处的波段增益，单位为 dB。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecteq10.rst b/classes/zh_CN/class_audioeffecteq10.rst index 7bf6691aea..d016e9552b 100644 --- a/classes/zh_CN/class_audioeffecteq10.rst +++ b/classes/zh_CN/class_audioeffecteq10.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectEQ10.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ10.xml. .. _class_AudioEffectEQ10: @@ -53,6 +53,7 @@ AudioEffectEQ10 - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecteq21.rst b/classes/zh_CN/class_audioeffecteq21.rst index f2ba1a7a94..a20787ab89 100644 --- a/classes/zh_CN/class_audioeffecteq21.rst +++ b/classes/zh_CN/class_audioeffecteq21.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectEQ21.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ21.xml. .. _class_AudioEffectEQ21: @@ -75,6 +75,7 @@ AudioEffectEQ21 - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecteq6.rst b/classes/zh_CN/class_audioeffecteq6.rst index 4aed0f2f26..70132928df 100644 --- a/classes/zh_CN/class_audioeffecteq6.rst +++ b/classes/zh_CN/class_audioeffecteq6.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectEQ6.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ6.xml. .. _class_AudioEffectEQ6: @@ -45,6 +45,7 @@ AudioEffectEQ6 - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectfilter.rst b/classes/zh_CN/class_audioeffectfilter.rst index ce01b1223f..c82eb0a6d4 100644 --- a/classes/zh_CN/class_audioeffectfilter.rst +++ b/classes/zh_CN/class_audioeffectfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectFilter.xml. .. _class_AudioEffectFilter: @@ -169,6 +169,7 @@ enum **FilterDB**: :ref:`🔗` 在截断频率附近的频率范围内的提升量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecthardlimiter.rst b/classes/zh_CN/class_audioeffecthardlimiter.rst index be08471395..41227b6359 100644 --- a/classes/zh_CN/class_audioeffecthardlimiter.rst +++ b/classes/zh_CN/class_audioeffecthardlimiter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectHardLimiter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectHardLimiter.xml. .. _class_AudioEffectHardLimiter: @@ -103,6 +103,7 @@ AudioEffectHardLimiter 增益降低完全释放所需的时间（以秒为单位）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecthighpassfilter.rst b/classes/zh_CN/class_audioeffecthighpassfilter.rst index fca249659e..93c4857e2c 100644 --- a/classes/zh_CN/class_audioeffecthighpassfilter.rst +++ b/classes/zh_CN/class_audioeffecthighpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectHighPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectHighPassFilter.xml. .. _class_AudioEffectHighPassFilter: @@ -29,6 +29,7 @@ AudioEffectHighPassFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffecthighshelffilter.rst b/classes/zh_CN/class_audioeffecthighshelffilter.rst index 9a6c7f8834..92cba57f1c 100644 --- a/classes/zh_CN/class_audioeffecthighshelffilter.rst +++ b/classes/zh_CN/class_audioeffecthighshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectHighShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectHighShelfFilter.xml. .. _class_AudioEffectHighShelfFilter: @@ -29,6 +29,7 @@ AudioEffectHighShelfFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectinstance.rst b/classes/zh_CN/class_audioeffectinstance.rst index 8bd3d6e5dc..4802c1f018 100644 --- a/classes/zh_CN/class_audioeffectinstance.rst +++ b/classes/zh_CN/class_audioeffectinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectInstance.xml. .. _class_AudioEffectInstance: @@ -38,11 +38,11 @@ AudioEffectInstance .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_process`\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_process_silence`\ (\ ) |virtual| |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process`\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| |required| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_process_silence`\ (\ ) |virtual| |const| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -57,7 +57,7 @@ AudioEffectInstance .. rst-class:: classref-method -|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 由 :ref:`AudioServer` 调用来处理该效果。当 :ref:`_process_silence()` 未被覆盖或返回 ``false`` 时，该方法仅在总线处于活动状态时调用。 @@ -78,6 +78,7 @@ AudioEffectInstance 应返回 ``true`` 以强制 :ref:`AudioServer` 始终调用 :ref:`_process()`\ ，即使总线已静音或无法听到。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectlimiter.rst b/classes/zh_CN/class_audioeffectlimiter.rst index d95820c5ac..bf06ed4772 100644 --- a/classes/zh_CN/class_audioeffectlimiter.rst +++ b/classes/zh_CN/class_audioeffectlimiter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectLimiter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLimiter.xml. .. _class_AudioEffectLimiter: @@ -126,6 +126,7 @@ AudioEffectLimiter 限制器开始生效的阈值，以分贝为单位。值的范围可以从 -30 到 0。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectlowpassfilter.rst b/classes/zh_CN/class_audioeffectlowpassfilter.rst index 49b4d9d209..3ad34cf788 100644 --- a/classes/zh_CN/class_audioeffectlowpassfilter.rst +++ b/classes/zh_CN/class_audioeffectlowpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectLowPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLowPassFilter.xml. .. _class_AudioEffectLowPassFilter: @@ -29,6 +29,7 @@ AudioEffectLowPassFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectlowshelffilter.rst b/classes/zh_CN/class_audioeffectlowshelffilter.rst index e0094bfeac..83f5977a0d 100644 --- a/classes/zh_CN/class_audioeffectlowshelffilter.rst +++ b/classes/zh_CN/class_audioeffectlowshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectLowShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLowShelfFilter.xml. .. _class_AudioEffectLowShelfFilter: @@ -29,6 +29,7 @@ AudioEffectLowShelfFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectnotchfilter.rst b/classes/zh_CN/class_audioeffectnotchfilter.rst index fc02914c96..dad7c15fa9 100644 --- a/classes/zh_CN/class_audioeffectnotchfilter.rst +++ b/classes/zh_CN/class_audioeffectnotchfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectNotchFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectNotchFilter.xml. .. _class_AudioEffectNotchFilter: @@ -29,6 +29,7 @@ AudioEffectNotchFilter - :doc:`音频总线 <../tutorials/audio/audio_buses>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectpanner.rst b/classes/zh_CN/class_audioeffectpanner.rst index 53f8141c74..f927b08436 100644 --- a/classes/zh_CN/class_audioeffectpanner.rst +++ b/classes/zh_CN/class_audioeffectpanner.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectPanner.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPanner.xml. .. _class_AudioEffectPanner: @@ -63,6 +63,7 @@ AudioEffectPanner 声像位置。值的范围可以从 -1（完全左）到1（完全右）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectphaser.rst b/classes/zh_CN/class_audioeffectphaser.rst index 153bfb162c..8d4635525d 100644 --- a/classes/zh_CN/class_audioeffectphaser.rst +++ b/classes/zh_CN/class_audioeffectphaser.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectPhaser.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPhaser.xml. .. _class_AudioEffectPhaser: @@ -70,7 +70,7 @@ AudioEffectPhaser - |void| **set_depth**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_depth**\ (\ ) -控制滤波器频率扫描的高度。较低的值将主要影响低音频率。高值可以推高高音。值的范围可以从 0.1 到 4。 +控制滤波器频率扫描的高度。较低的值主要影响低音频率。较高的值可以推高高音。取值范围为 ``0.1`` 到 ``4.0``\ 。 .. rst-class:: classref-item-separator @@ -141,6 +141,7 @@ AudioEffectPhaser 以 Hz 为单位调整效果在整个频率范围内上下扫描的速度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectpitchshift.rst b/classes/zh_CN/class_audioeffectpitchshift.rst index 89c16243f8..1620cb477e 100644 --- a/classes/zh_CN/class_audioeffectpitchshift.rst +++ b/classes/zh_CN/class_audioeffectpitchshift.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectPitchShift.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPitchShift.xml. .. _class_AudioEffectPitchShift: @@ -166,6 +166,7 @@ enum **FFTSize**: :ref:`🔗` 要使用的音高缩放。\ ``1.0`` 是默认的音高，声音会按原样播放。\ :ref:`pitch_scale` 的范围从 ``0.0``\ （无限低的音高，听不见）到 ``16``\ （比初始音高要高 16 倍）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectrecord.rst b/classes/zh_CN/class_audioeffectrecord.rst index b3f85bcf67..845079f9cd 100644 --- a/classes/zh_CN/class_audioeffectrecord.rst +++ b/classes/zh_CN/class_audioeffectrecord.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectRecord.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectRecord.xml. .. _class_AudioEffectRecord: @@ -84,7 +84,7 @@ AudioEffectRecord - |void| **set_format**\ (\ value\: :ref:`Format`\ ) - :ref:`Format` **get_format**\ (\ ) -指定样本将被记录的格式。有关可用格式，请参阅 :ref:`Format`\ 。 +指定样本的记录格式。 .. rst-class:: classref-section-separator @@ -128,6 +128,7 @@ AudioEffectRecord 如果为 ``true``\ ，将录制声音。请注意，重新开始录音将移除先前录音的样本。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectreverb.rst b/classes/zh_CN/class_audioeffectreverb.rst index 9ca607edbd..4318c375c4 100644 --- a/classes/zh_CN/class_audioeffectreverb.rst +++ b/classes/zh_CN/class_audioeffectreverb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectReverb.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectReverb.xml. .. _class_AudioEffectReverb: @@ -198,6 +198,7 @@ AudioEffectReverb 修改后声音的输出百分比。为 0 时，只输出原始声音。取值范围是 0 到 1。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectspectrumanalyzer.rst b/classes/zh_CN/class_audioeffectspectrumanalyzer.rst index cf04b8a34d..44d2c8891e 100644 --- a/classes/zh_CN/class_audioeffectspectrumanalyzer.rst +++ b/classes/zh_CN/class_audioeffectspectrumanalyzer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectSpectrumAnalyzer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectSpectrumAnalyzer.xml. .. _class_AudioEffectSpectrumAnalyzer: @@ -170,6 +170,7 @@ enum **FFTSize**: :ref:`🔗` 该属性目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectspectrumanalyzerinstance.rst b/classes/zh_CN/class_audioeffectspectrumanalyzerinstance.rst index fd17a04478..153dd616dc 100644 --- a/classes/zh_CN/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/zh_CN/class_audioeffectspectrumanalyzerinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. .. _class_AudioEffectSpectrumAnalyzerInstance: @@ -90,9 +90,10 @@ enum **MagnitudeMode**: :ref:`🔗`\ 。 +\ ``mode`` 决定的是频率范围的处理方式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioeffectstereoenhance.rst b/classes/zh_CN/class_audioeffectstereoenhance.rst index 31e18fd21e..4ab6075d72 100644 --- a/classes/zh_CN/class_audioeffectstereoenhance.rst +++ b/classes/zh_CN/class_audioeffectstereoenhance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioEffectStereoEnhance.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectStereoEnhance.xml. .. _class_AudioEffectStereoEnhance: @@ -101,6 +101,7 @@ AudioEffectStereoEnhance 通过在偏移相位时结合\ :ref:`surround`\ 来拓宽声场。若\ :ref:`surround`\ 为0，则仅延迟右声道。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiolistener2d.rst b/classes/zh_CN/class_audiolistener2d.rst index cd5181ae5c..ed5a4930de 100644 --- a/classes/zh_CN/class_audiolistener2d.rst +++ b/classes/zh_CN/class_audiolistener2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioListener2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioListener2D.xml. .. _class_AudioListener2D: @@ -86,6 +86,7 @@ AudioListener2D 如果 **AudioListener2D** 未添加到 :ref:`SceneTree`\ ，则该方法无效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiolistener3d.rst b/classes/zh_CN/class_audiolistener3d.rst index 0354a52b1a..8923f36a1e 100644 --- a/classes/zh_CN/class_audiolistener3d.rst +++ b/classes/zh_CN/class_audiolistener3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioListener3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioListener3D.xml. .. _class_AudioListener3D: @@ -26,6 +26,18 @@ AudioListener3D .. rst-class:: classref-reftable-group +属性 +---- + +.. table:: + :widths: auto + + +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ + | :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | + +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + 方法 ---- @@ -48,6 +60,69 @@ AudioListener3D .. rst-class:: classref-descriptions-group +枚举 +---- + +.. _enum_AudioListener3D_DopplerTracking: + +.. rst-class:: classref-enumeration + +enum **DopplerTracking**: :ref:`🔗` + +.. _class_AudioListener3D_constant_DOPPLER_TRACKING_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DopplerTracking` **DOPPLER_TRACKING_DISABLED** = ``0`` + +禁用\ `多普勒效应 `__\ 模拟（默认）。 + +.. _class_AudioListener3D_constant_DOPPLER_TRACKING_IDLE_STEP: + +.. rst-class:: classref-enumeration-constant + +:ref:`DopplerTracking` **DOPPLER_TRACKING_IDLE_STEP** = ``1`` + +通过跟踪在 ``_process`` 中改变的物体位置来模拟\ `多普勒效应 `__\ 。该监听器相对于这些物体的相对速度的变化会影响音频的感知方式（改变音频的 :ref:`AudioStreamPlayer3D.pitch_scale`\ ）。 + +.. _class_AudioListener3D_constant_DOPPLER_TRACKING_PHYSICS_STEP: + +.. rst-class:: classref-enumeration-constant + +:ref:`DopplerTracking` **DOPPLER_TRACKING_PHYSICS_STEP** = ``2`` + +通过跟踪在 ``_process`` 中改变的物体位置来模拟\ `多普勒效应 `__\ 。该监听器相对于这些物体的相对速度的变化会影响音频的感知方式（改变音频的 :ref:`AudioStreamPlayer3D.pitch_scale`\ ）。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_AudioListener3D_property_doppler_tracking: + +.. rst-class:: classref-property + +:ref:`DopplerTracking` **doppler_tracking** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking`\ ) +- :ref:`DopplerTracking` **get_doppler_tracking**\ (\ ) + +如果不是 :ref:`DOPPLER_TRACKING_DISABLED`\ ，则该监听器将在特定的 ``_process`` 方法中，为变化的对象模拟\ `多普勒效应 `__\ 。 + +\ **注意：**\ 多普勒效应仅在 :ref:`AudioStreamPlayer3D.doppler_tracking` 未设置为 :ref:`AudioStreamPlayer3D.DOPPLER_TRACKING_DISABLED` 时才会在 :ref:`AudioStreamPlayer3D` 上听到。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 方法说明 -------- @@ -98,6 +173,7 @@ AudioListener3D 启用该监听器。将覆盖当前相机的监听器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiosample.rst b/classes/zh_CN/class_audiosample.rst index 6fa49b4ca5..efa3f6a77c 100644 --- a/classes/zh_CN/class_audiosample.rst +++ b/classes/zh_CN/class_audiosample.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioSample.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioSample.xml. .. _class_AudioSample: @@ -24,6 +24,7 @@ AudioSample 音频样本的基类。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiosampleplayback.rst b/classes/zh_CN/class_audiosampleplayback.rst index 0114f84f64..e29c14118e 100644 --- a/classes/zh_CN/class_audiosampleplayback.rst +++ b/classes/zh_CN/class_audiosampleplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioSamplePlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioSamplePlayback.xml. .. _class_AudioSamplePlayback: @@ -24,6 +24,7 @@ AudioSamplePlayback 用于播放音频样本的元类。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audioserver.rst b/classes/zh_CN/class_audioserver.rst index ea82d83377..7429d5f40d 100644 --- a/classes/zh_CN/class_audioserver.rst +++ b/classes/zh_CN/class_audioserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioServer.xml. .. _class_AudioServer: @@ -923,6 +923,7 @@ enum **PlaybackType**: :ref:`🔗` 解锁音频驱动程序的主循环。（锁定后，你始终需要手动解锁它。） .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostream.rst b/classes/zh_CN/class_audiostream.rst index ab7a5db3aa..cd351aba4e 100644 --- a/classes/zh_CN/class_audiostream.rst +++ b/classes/zh_CN/class_audiostream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStream.xml. .. _class_AudioStream: @@ -57,6 +57,8 @@ AudioStream +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_stream_name`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_tags`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_loop`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStreamPlayback` | :ref:`_instantiate_playback`\ (\ ) |virtual| |const| | @@ -178,6 +180,20 @@ AudioStream ---- +.. _class_AudioStream_private_method__get_tags: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_tags**\ (\ ) |virtual| |const| :ref:`🔗` + +覆盖该方法，自定义音频流的标签。应当返回字符串构成的 :ref:`Dictionary`\ ，标签为键，对应的内容为值。 + +常用标签包括标题 ``title``\ 、艺术家 ``artist``\ 、专辑 ``album``\ 、音轨号 ``tracknumber``\ 、日期 ``date``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioStream_private_method__has_loop: .. rst-class:: classref-method @@ -248,7 +264,7 @@ AudioStream :ref:`float` **get_length**\ (\ ) |const| :ref:`🔗` -返回音频流的长度，单位为秒。 +返回音频流的长度，单位为秒。如果是 :ref:`AudioStreamRandomizer`\ ，则返回最近一次播放的音频流的长度。如果音频流的长度无限（如 :ref:`AudioStreamGenerator` 和 :ref:`AudioStreamMicrophone`\ ）则返回 ``0.0``\ 。 .. rst-class:: classref-item-separator @@ -287,6 +303,7 @@ AudioStream 如果该音频流仅支持一个通道（\ *单声道*\ ），则返回 ``true``\ ；如果音频流支持两个或多个通道（\ *复调*\ ），则返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamgenerator.rst b/classes/zh_CN/class_audiostreamgenerator.rst index 7d28db45b7..c3f6d45c20 100644 --- a/classes/zh_CN/class_audiostreamgenerator.rst +++ b/classes/zh_CN/class_audiostreamgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamGenerator.xml. .. _class_AudioStreamGenerator: @@ -32,16 +32,16 @@ AudioStreamGenerator @onready var sample_hz = $AudioStreamPlayer.stream.mix_rate var pulse_hz = 440.0 # 声音波形的频率。 var phase = 0.0 - + func _ready(): $AudioStreamPlayer.play() playback = $AudioStreamPlayer.get_stream_playback() fill_buffer() - + func fill_buffer(): var increment = pulse_hz / sample_hz var frames_available = playback.get_frames_available() - + for i in range(frames_available): playback.push_frame(Vector2.ONE * sin(phase * TAU)) phase = fmod(phase + increment, 1.0) @@ -49,12 +49,12 @@ AudioStreamGenerator .. code-tab:: csharp [Export] public AudioStreamPlayer Player { get; set; } - + private AudioStreamGeneratorPlayback _playback; // 存放 AudioStreamGeneratorPlayback。 private float _sampleHz; private float _pulseHz = 440.0f; // 音频波形的频率。 private double phase = 0.0; - + public override void _Ready() { if (Player.Stream is AudioStreamGenerator generator) // Type as a generator to access MixRate. @@ -65,12 +65,12 @@ AudioStreamGenerator FillBuffer(); } } - + public void FillBuffer() { float increment = _pulseHz / _sampleHz; int framesAvailable = _playback.GetFramesAvailable(); - + for (int i = 0; i < framesAvailable; i++) { _playback.PushFrame(Vector2.One * (float)Mathf.Sin(phase * Mathf.Tau)); @@ -221,6 +221,7 @@ enum **AudioStreamGeneratorMixRate**: :ref:`🔗` 则会使用 :ref:`mix_rate`\ ，否则会使用 :ref:`AudioServer` 的混音率。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamgeneratorplayback.rst b/classes/zh_CN/class_audiostreamgeneratorplayback.rst index 47cd72faee..8dc9a1f590 100644 --- a/classes/zh_CN/class_audiostreamgeneratorplayback.rst +++ b/classes/zh_CN/class_audiostreamgeneratorplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamGeneratorPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamGeneratorPlayback.xml. .. _class_AudioStreamGeneratorPlayback: @@ -130,6 +130,7 @@ AudioStreamGeneratorPlayback 将单个音频数据帧推送到缓冲区。这通常比 C# 中的以及通过 GDExtension 编译的语言中的 :ref:`push_buffer()` 效率更低，但在 GDScript 中的 :ref:`push_frame()` 的效率可能\ *更高*\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreaminteractive.rst b/classes/zh_CN/class_audiostreaminteractive.rst index 86056d885e..d4647f1060 100644 --- a/classes/zh_CN/class_audiostreaminteractive.rst +++ b/classes/zh_CN/class_audiostreaminteractive.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamInteractive.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamInteractive.xml. .. _class_AudioStreamInteractive: @@ -546,6 +546,7 @@ enum **AutoAdvanceMode**: :ref:`🔗`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreammicrophone.rst b/classes/zh_CN/class_audiostreammicrophone.rst index aac561e878..dd4960de57 100644 --- a/classes/zh_CN/class_audiostreammicrophone.rst +++ b/classes/zh_CN/class_audiostreammicrophone.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamMicrophone.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamMicrophone.xml. .. _class_AudioStreamMicrophone: @@ -33,6 +33,7 @@ AudioStreamMicrophone - `音频麦克风录音演示 `__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreammp3.rst b/classes/zh_CN/class_audiostreammp3.rst index 680230879f..7e664e508c 100644 --- a/classes/zh_CN/class_audiostreammp3.rst +++ b/classes/zh_CN/class_audiostreammp3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/minimp3/doc_classes/AudioStreamMP3.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/AudioStreamMP3.xml. .. _class_AudioStreamMP3: @@ -229,6 +229,7 @@ MP3 音频流驱动。如果你想要在运行时加载 MP3 文件，请参阅 : 从给定的文件路径新建 **AudioStreamMP3** 实例。文件必须为 MP3 格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamoggvorbis.rst b/classes/zh_CN/class_audiostreamoggvorbis.rst index 70de4bdabe..175845efd0 100644 --- a/classes/zh_CN/class_audiostreamoggvorbis.rst +++ b/classes/zh_CN/class_audiostreamoggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml. .. _class_AudioStreamOggVorbis: @@ -49,6 +49,8 @@ AudioStreamOggVorbis 类是专用于处理 Ogg Vorbis 文件格式的 :ref:`Audi +---------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`OggPacketSequence` | :ref:`packet_sequence` | | +---------------------------------------------------+-----------------------------------------------------------------------------+-----------+ + | :ref:`Dictionary` | :ref:`tags` | ``{}`` | + +---------------------------------------------------+-----------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -177,6 +179,27 @@ AudioStreamOggVorbis 类是专用于处理 Ogg Vorbis 文件格式的 :ref:`Audi 包含用于这个流的原始 Ogg 数据。 +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamOggVorbis_property_tags: + +.. rst-class:: classref-property + +:ref:`Dictionary` **tags** = ``{}`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tags**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_tags**\ (\ ) + +如果在 Ogg Vorbis 数据中存在标签，则包含用户定义的标签。 + +常用标签包括标题 ``title``\ 、艺术家 ``artist``\ 、专辑 ``album``\ 、音轨号 ``tracknumber``\ 、日期 ``date``\ （\ ``date`` 没有标准日期格式）。 + +\ **注意：**\ 无法\ *保证*\ 每个文件中都有某个标签，因此请考虑键可能不是始终存在。 + .. rst-class:: classref-section-separator ---- @@ -207,6 +230,7 @@ AudioStreamOggVorbis 类是专用于处理 Ogg Vorbis 文件格式的 :ref:`Audi 从给定的文件路径新建 **AudioStreamOggVorbis** 实例。文件必须为 Ogg Vorbis 格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplayback.rst b/classes/zh_CN/class_audiostreamplayback.rst index d9261c9796..0dcd7c9653 100644 --- a/classes/zh_CN/class_audiostreamplayback.rst +++ b/classes/zh_CN/class_audiostreamplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayback.xml. .. _class_AudioStreamPlayback: @@ -38,45 +38,45 @@ AudioStreamPlayback .. table:: :widths: auto - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_stop`\ (\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_loop_count`\ (\ ) |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playback_position`\ (\ ) |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioSamplePlayback` | :ref:`get_sample_playback`\ (\ ) |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`mix_audio`\ (\ rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`seek`\ (\ time\: :ref:`float` = 0.0\ ) | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_sample_playback`\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`start`\ (\ from_pos\: :ref:`float` = 0.0\ ) | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`stop`\ (\ ) | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stop`\ (\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_loop_count`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playback_position`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioSamplePlayback` | :ref:`get_sample_playback`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`mix_audio`\ (\ rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ time\: :ref:`float` = 0.0\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_playback`\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start`\ (\ from_pos\: :ref:`float` = 0.0\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -139,7 +139,7 @@ AudioStreamPlayback .. rst-class:: classref-method -:ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 覆盖该方法以自定义音频流的混合方式。即使播放未激活，也会调用该方法。 @@ -322,6 +322,7 @@ AudioStreamPlayback 停止音频流。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybackinteractive.rst b/classes/zh_CN/class_audiostreamplaybackinteractive.rst index 16bcee3a22..9c96f4e021 100644 --- a/classes/zh_CN/class_audiostreamplaybackinteractive.rst +++ b/classes/zh_CN/class_audiostreamplaybackinteractive.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamPlaybackInteractive.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackInteractive.xml. .. _class_AudioStreamPlaybackInteractive: @@ -90,6 +90,7 @@ AudioStreamPlaybackInteractive 切换到剪辑（根据名称）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybackoggvorbis.rst b/classes/zh_CN/class_audiostreamplaybackoggvorbis.rst index 59e7c7ac3d..ee3dc8883d 100644 --- a/classes/zh_CN/class_audiostreamplaybackoggvorbis.rst +++ b/classes/zh_CN/class_audiostreamplaybackoggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/vorbis/doc_classes/AudioStreamPlaybackOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/AudioStreamPlaybackOggVorbis.xml. .. _class_AudioStreamPlaybackOggVorbis: @@ -17,6 +17,7 @@ AudioStreamPlaybackOggVorbis 该类目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybackplaylist.rst b/classes/zh_CN/class_audiostreamplaybackplaylist.rst index 06e9e62065..9bf9034824 100644 --- a/classes/zh_CN/class_audiostreamplaybackplaylist.rst +++ b/classes/zh_CN/class_audiostreamplaybackplaylist.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamPlaybackPlaylist.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackPlaylist.xml. .. _class_AudioStreamPlaybackPlaylist: @@ -15,6 +15,7 @@ AudioStreamPlaybackPlaylist :ref:`AudioStreamPlaylist` 使用的播放类。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybackpolyphonic.rst b/classes/zh_CN/class_audiostreamplaybackpolyphonic.rst index ca6471897c..9797fc0489 100644 --- a/classes/zh_CN/class_audiostreamplaybackpolyphonic.rst +++ b/classes/zh_CN/class_audiostreamplaybackpolyphonic.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlaybackPolyphonic.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlaybackPolyphonic.xml. .. _class_AudioStreamPlaybackPolyphonic: @@ -130,6 +130,7 @@ AudioStreamPlaybackPolyphonic 停止某个流。\ ``stream`` 参数是由 :ref:`play_stream()` 返回的整数 ID，在调用这个函数后失效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybackresampled.rst b/classes/zh_CN/class_audiostreamplaybackresampled.rst index ac6fc64a5d..5f7780716d 100644 --- a/classes/zh_CN/class_audiostreamplaybackresampled.rst +++ b/classes/zh_CN/class_audiostreamplaybackresampled.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlaybackResampled.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlaybackResampled.xml. .. _class_AudioStreamPlaybackResampled: @@ -26,13 +26,13 @@ AudioStreamPlaybackResampled .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_stream_sampling_rate`\ (\ ) |virtual| |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_mix_resampled`\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`begin_resample`\ (\ ) | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_stream_sampling_rate`\ (\ ) |virtual| |required| |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_mix_resampled`\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| |required| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_resample`\ (\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -47,7 +47,7 @@ AudioStreamPlaybackResampled .. rst-class:: classref-method -:ref:`float` **_get_stream_sampling_rate**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_stream_sampling_rate**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -61,7 +61,7 @@ AudioStreamPlaybackResampled .. rst-class:: classref-method -:ref:`int` **_mix_resampled**\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_mix_resampled**\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -82,6 +82,7 @@ AudioStreamPlaybackResampled 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaybacksynchronized.rst b/classes/zh_CN/class_audiostreamplaybacksynchronized.rst index de87b4c5eb..ea64a366b3 100644 --- a/classes/zh_CN/class_audiostreamplaybacksynchronized.rst +++ b/classes/zh_CN/class_audiostreamplaybacksynchronized.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamPlaybackSynchronized.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackSynchronized.xml. .. _class_AudioStreamPlaybackSynchronized: @@ -17,6 +17,7 @@ AudioStreamPlaybackSynchronized 该类目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplayer.rst b/classes/zh_CN/class_audiostreamplayer.rst index f66d2bbcd5..a4dc81ba73 100644 --- a/classes/zh_CN/class_audiostreamplayer.rst +++ b/classes/zh_CN/class_audiostreamplayer.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer.xml. .. _class_AudioStreamPlayer: @@ -228,7 +228,7 @@ enum **MixTarget**: :ref:`🔗` - |void| **set_mix_target**\ (\ value\: :ref:`MixTarget`\ ) - :ref:`MixTarget` **get_mix_target**\ (\ ) -混合目标声道，使用 :ref:`MixTarget` 常量。检测到小于等于两个扬声器时无效（见 :ref:`SpeakerMode`\ ）。 +混合目标声道。检测到小于等于两个扬声器时无效（见 :ref:`SpeakerMode`\ ）。 .. rst-class:: classref-item-separator @@ -439,6 +439,7 @@ enum **MixTarget**: :ref:`🔗` 停止该节点发出的所有声音。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplayer2d.rst b/classes/zh_CN/class_audiostreamplayer2d.rst index 56379c3c1f..cbe9e03138 100644 --- a/classes/zh_CN/class_audiostreamplayer2d.rst +++ b/classes/zh_CN/class_audiostreamplayer2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlayer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer2D.xml. .. _class_AudioStreamPlayer2D: @@ -441,6 +441,7 @@ AudioStreamPlayer2D 停止音频。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplayer3d.rst b/classes/zh_CN/class_audiostreamplayer3d.rst index f7a3891e35..8b488a50ba 100644 --- a/classes/zh_CN/class_audiostreamplayer3d.rst +++ b/classes/zh_CN/class_audiostreamplayer3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPlayer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer3D.xml. .. _class_AudioStreamPlayer3D: @@ -335,7 +335,9 @@ enum **DopplerTracking**: :ref:`🔗` - |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking`\ ) - :ref:`DopplerTracking` **get_doppler_tracking**\ (\ ) -决定应该在哪个步骤计算多普勒效应。 +决定在哪一步计算多普勒效应。 + +\ **注意：**\ 如果 :ref:`doppler_tracking` 的值不是 :ref:`DOPPLER_TRACKING_DISABLED`\ ，且当前 :ref:`Camera3D`/:ref:`AudioListener3D` 禁用了多普勒跟踪，则多普勒效应会被听到，但不会考虑当前监听器的移动。如果需要精确的多普勒效应，则应在 **AudioStreamPlayer3D** 和当前 :ref:`Camera3D`/:ref:`AudioListener3D` 上同时启用多普勒跟踪。 .. rst-class:: classref-item-separator @@ -454,7 +456,11 @@ enum **DopplerTracking**: :ref:`🔗` - |void| **set_panning_strength**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_panning_strength**\ (\ ) -通过将基础 :ref:`ProjectSettings.audio/general/3d_panning_strength` 乘以该因子，来缩放该节点的声像强度。与较低的值相比，较高的值将从左到右更显著地声像移动音频。 +该系数会与基础的 :ref:`ProjectSettings.audio/general/3d_panning_strength` 相乘，缩放节点的声像强度。如果乘积为 ``0.0`` 则禁用立体声声像，所有声道的音量相同。如果乘积为 ``1.0`` 则当声音位于听者的正左（或正右）时，有一个通道将被静音。 + +两个扬声器的立体声配置实现了 `WebAudio 标准的 StereoPannerNode 声像 `__\ ，音量为到耳朵的半方位角的余弦值。 + +5.1 和 7.1 等其他扬声器配置则实现了 SPCAP（扬声器放置校正幅度）算法。 .. rst-class:: classref-item-separator @@ -674,6 +680,7 @@ enum **DopplerTracking**: :ref:`🔗` 停止音频。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamplaylist.rst b/classes/zh_CN/class_audiostreamplaylist.rst index d5abf73a2a..4440b13ac5 100644 --- a/classes/zh_CN/class_audiostreamplaylist.rst +++ b/classes/zh_CN/class_audiostreamplaylist.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamPlaylist.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaylist.xml. .. _class_AudioStreamPlaylist: @@ -180,6 +180,7 @@ AudioStreamPlaylist 设置播放位置索引处的音频流。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreampolyphonic.rst b/classes/zh_CN/class_audiostreampolyphonic.rst index db822a01d4..db69430bd1 100644 --- a/classes/zh_CN/class_audiostreampolyphonic.rst +++ b/classes/zh_CN/class_audiostreampolyphonic.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamPolyphonic.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPolyphonic.xml. .. _class_AudioStreamPolyphonic: @@ -58,6 +58,7 @@ AudioStream 允许用户随时通过代码，同时使用单个播放器播放 可以同时播放的流的最大数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamrandomizer.rst b/classes/zh_CN/class_audiostreamrandomizer.rst index 5802827b6a..8dad22ad9b 100644 --- a/classes/zh_CN/class_audiostreamrandomizer.rst +++ b/classes/zh_CN/class_audiostreamrandomizer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamRandomizer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamRandomizer.xml. .. _class_AudioStreamRandomizer: @@ -265,6 +265,7 @@ enum **PlaybackMode**: :ref:`🔗` 设置流在指定索引处的概率权重。该值越高，随机化器在随机播放模式下选择该流的可能性就越大。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamsynchronized.rst b/classes/zh_CN/class_audiostreamsynchronized.rst index 5ab2890399..b1f4374d4d 100644 --- a/classes/zh_CN/class_audiostreamsynchronized.rst +++ b/classes/zh_CN/class_audiostreamsynchronized.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/interactive_music/doc_classes/AudioStreamSynchronized.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamSynchronized.xml. .. _class_AudioStreamSynchronized: @@ -144,6 +144,7 @@ AudioStreamSynchronized 设置同步音频流的音量，使用索引号指定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_audiostreamwav.rst b/classes/zh_CN/class_audiostreamwav.rst index bc3b1fa883..0478d18c59 100644 --- a/classes/zh_CN/class_audiostreamwav.rst +++ b/classes/zh_CN/class_audiostreamwav.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioStreamWAV.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamWAV.xml. .. _class_AudioStreamWAV: @@ -53,6 +53,8 @@ AudioStreamWAV 存储从 WAV 文件加载的声音样本。要播放存储的声 +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`stereo` | ``false`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ + | :ref:`Dictionary` | :ref:`tags` | ``{}`` | + +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group @@ -202,7 +204,7 @@ enum **LoopMode**: :ref:`🔗` - |void| **set_format**\ (\ value\: :ref:`Format`\ ) - :ref:`Format` **get_format**\ (\ ) -音频格式。取值见 :ref:`Format` 常量。 +音频格式。 .. rst-class:: classref-item-separator @@ -253,7 +255,7 @@ enum **LoopMode**: :ref:`🔗` - |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode`\ ) - :ref:`LoopMode` **get_loop_mode**\ (\ ) -循环模式。取值见 :ref:`LoopMode` 常量。 +循环模式。 .. rst-class:: classref-item-separator @@ -293,6 +295,29 @@ enum **LoopMode**: :ref:`🔗` 如果为 ``true``\ ，则音频为立体声。 +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamWAV_property_tags: + +.. rst-class:: classref-property + +:ref:`Dictionary` **tags** = ``{}`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tags**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_tags**\ (\ ) + +如果在 WAV 数据中存在标签，则包含用户定义的标签。 + +常用标签包括标题 ``title``\ 、艺术家 ``artist``\ 、专辑 ``album``\ 、音轨号 ``tracknumber``\ 、日期 ``date``\ （\ ``date`` 没有标准日期格式）。 + +\ **注意：**\ 无法\ *保证*\ 每个文件中都有某个标签，因此请考虑键可能不是始终存在。 + +\ **注意：**\ 目前仅支持使用 ``LIST`` 块并且标识符为 ``INFO`` 的 WAV 文件编码标签。 + .. rst-class:: classref-section-separator ---- @@ -331,10 +356,10 @@ enum **LoopMode**: :ref:`🔗` :: @onready var audio_player = $AudioStreamPlayer - + func _ready(): get_window().files_dropped.connect(_on_files_dropped) - + func _on_files_dropped(files): if files[0].get_extension() == "wav": audio_player.stream = AudioStreamWAV.load_from_file(files[0], { @@ -358,6 +383,7 @@ enum **LoopMode**: :ref:`🔗` \ **注意：**\ 如果缺少 ``.wav`` 扩展名，则会自动将其追加到 ``path``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_backbuffercopy.rst b/classes/zh_CN/class_backbuffercopy.rst index 3ace0bdc97..3feda51d4f 100644 --- a/classes/zh_CN/class_backbuffercopy.rst +++ b/classes/zh_CN/class_backbuffercopy.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BackBufferCopy.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BackBufferCopy.xml. .. _class_BackBufferCopy: @@ -103,7 +103,7 @@ enum **CopyMode**: :ref:`🔗` - |void| **set_copy_mode**\ (\ value\: :ref:`CopyMode`\ ) - :ref:`CopyMode` **get_copy_mode**\ (\ ) -缓冲区模式。见 :ref:`CopyMode` 常量。 +缓冲模式。 .. rst-class:: classref-item-separator @@ -123,6 +123,7 @@ enum **CopyMode**: :ref:`🔗` 该 **BackBufferCopy** 所覆盖的区域。只有当 :ref:`copy_mode` 为 :ref:`COPY_MODE_RECT` 时才使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_basebutton.rst b/classes/zh_CN/class_basebutton.rst index 3ec134b425..e6cbd5060e 100644 --- a/classes/zh_CN/class_basebutton.rst +++ b/classes/zh_CN/class_basebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BaseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BaseButton.xml. .. _class_BaseButton: @@ -231,7 +231,7 @@ enum **ActionMode**: :ref:`🔗` - |void| **set_action_mode**\ (\ value\: :ref:`ActionMode`\ ) - :ref:`ActionMode` **get_action_mode**\ (\ ) -确定按钮何时被认为被点击，是 :ref:`ActionMode` 常量之一。 +认定按钮被点击的时机。 .. rst-class:: classref-item-separator @@ -307,6 +307,8 @@ enum **ActionMode**: :ref:`🔗` 如果为 ``true``\ ，则该按钮处于禁用状态，无法点击或切换。 +\ **注意：**\ 如果在处于按下状态时禁用按钮，则会发出 :ref:`button_up` 信号。 + .. rst-class:: classref-item-separator ---- @@ -464,6 +466,7 @@ enum **ActionMode**: :ref:`🔗` \ **注意：**\ 该方法不会取消按下 :ref:`button_group` 中的其他按钮。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_basematerial3d.rst b/classes/zh_CN/class_basematerial3d.rst index 43f76e6563..ea41d25927 100644 --- a/classes/zh_CN/class_basematerial3d.rst +++ b/classes/zh_CN/class_basematerial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BaseMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BaseMaterial3D.xml. .. _class_BaseMaterial3D: @@ -77,6 +77,10 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`backlight_texture` | | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`bent_normal_enabled` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`bent_normal_texture` | | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`billboard_keep_scale` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`BillboardMode` | :ref:`billboard_mode` | ``0`` | @@ -95,6 +99,8 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`DepthDrawMode` | :ref:`depth_draw_mode` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`DepthTest` | :ref:`depth_test` | ``0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`detail_albedo` | | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`BlendMode` | :ref:`detail_blend_mode` | ``0`` | @@ -115,6 +121,8 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`disable_receive_shadows` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`disable_specular_occlusion` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_max_distance` | ``10.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_min_distance` | ``0.0`` | @@ -137,6 +145,8 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`fixed_size` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`fov_override` | ``75.0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`grow` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`grow_amount` | ``0.0`` | @@ -221,6 +231,18 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`SpecularMode` | :ref:`specular_mode` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`stencil_color` | ``Color(0, 0, 0, 1)`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`StencilCompare` | :ref:`stencil_compare` | ``0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stencil_flags` | ``0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`StencilMode` | :ref:`stencil_mode` | ``0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`stencil_outline_thickness` | ``0.01`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stencil_reference` | ``1`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`subsurf_scatter_enabled` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`subsurf_scatter_skin_mode` | ``false`` | @@ -245,10 +267,14 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Transparency` | :ref:`transparency` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`use_fov_override` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`use_particle_trails` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`use_point_size` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`use_z_clip_scale` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`uv1_offset` | ``Vector3(0, 0, 0)`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`uv1_scale` | ``Vector3(1, 1, 1)`` | @@ -273,6 +299,8 @@ BaseMaterial3D +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`z_clip_scale` | ``1.0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group @@ -351,6 +379,14 @@ enum **TextureParam**: :ref:`🔗` 指定每个像素法向量的纹理。 +.. _class_BaseMaterial3D_constant_TEXTURE_BENT_NORMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_BENT_NORMAL** = ``18`` + +指定每个像素弯曲法向量的纹理。 + .. _class_BaseMaterial3D_constant_TEXTURE_RIM: .. rst-class:: classref-enumeration-constant @@ -459,7 +495,7 @@ enum **TextureParam**: :ref:`🔗` .. rst-class:: classref-enumeration-constant -:ref:`TextureParam` **TEXTURE_MAX** = ``18`` +:ref:`TextureParam` **TEXTURE_MAX** = ``19`` 代表 :ref:`TextureParam` 枚举的大小。 @@ -761,11 +797,19 @@ enum **Feature**: :ref:`🔗` 用于设置 :ref:`detail_enabled` 的常量。 +.. _class_BaseMaterial3D_constant_FEATURE_BENT_NORMAL_MAPPING: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_BENT_NORMAL_MAPPING** = ``12`` + +用于设置 :ref:`bent_normal_enabled` 的常量。 + .. _class_BaseMaterial3D_constant_FEATURE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Feature` **FEATURE_MAX** = ``12`` +:ref:`Feature` **FEATURE_MAX** = ``13`` 代表 :ref:`Feature` 枚举的大小。 @@ -893,6 +937,32 @@ enum **DepthDrawMode**: :ref:`🔗` ---- +.. _enum_BaseMaterial3D_DepthTest: + +.. rst-class:: classref-enumeration + +enum **DepthTest**: :ref:`🔗` + +.. _class_BaseMaterial3D_constant_DEPTH_TEST_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthTest` **DEPTH_TEST_DEFAULT** = ``0`` + +深度测试会丢弃位于其他像素后面的像素。 + +.. _class_BaseMaterial3D_constant_DEPTH_TEST_INVERTED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthTest` **DEPTH_TEST_INVERTED** = ``1`` + +深度测试会丢弃位于其他像素前面的像素。适用于模板效果。 + +.. rst-class:: classref-item-separator + +---- + .. _enum_BaseMaterial3D_CullMode: .. rst-class:: classref-enumeration @@ -1111,11 +1181,35 @@ enum **Flags**: :ref:`🔗` 禁用接收基于深度或体积雾。 +.. _class_BaseMaterial3D_constant_FLAG_DISABLE_SPECULAR_OCCLUSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_DISABLE_SPECULAR_OCCLUSION** = ``22`` + +禁用镜面反射遮蔽。 + +.. _class_BaseMaterial3D_constant_FLAG_USE_Z_CLIP_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_Z_CLIP_SCALE** = ``23`` + +启用 :ref:`z_clip_scale`\ 。 + +.. _class_BaseMaterial3D_constant_FLAG_USE_FOV_OVERRIDE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_FOV_OVERRIDE** = ``24`` + +启用 :ref:`fov_override`\ 。 + .. _class_BaseMaterial3D_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Flags` **FLAG_MAX** = ``22`` +:ref:`Flags` **FLAG_MAX** = ``25`` 代表 :ref:`Flags` 枚举的大小。 @@ -1179,6 +1273,10 @@ enum **SpecularMode**: :ref:`🔗` 默认镜面反射斑点。 +\ **注意：**\ Forward+ 使用多重散射实现更精确的反射，不过多重散射带来的影响在粗糙金属表面上比在平滑非金属表面上更明显。 + +\ **注意：**\ Mobile 和 Compatibility 由于性能原因执行的不是多重散射而是单散射，因此粗糙金属表面可能比预期的要暗一些。 + .. _class_BaseMaterial3D_constant_SPECULAR_TOON: .. rst-class:: classref-enumeration-constant @@ -1357,6 +1455,152 @@ enum **DistanceFadeMode**: :ref:`🔗` 根据对象与相机的距离，使用一种抖动方法平滑淡出对象。抖动根据设定的模式丢弃像素，在不启用透明的情况下平滑淡化。在某些硬件上，该选项可能比 :ref:`DISTANCE_FADE_PIXEL_ALPHA` 和 :ref:`DISTANCE_FADE_PIXEL_DITHER` 更快。 +.. rst-class:: classref-item-separator + +---- + +.. _enum_BaseMaterial3D_StencilMode: + +.. rst-class:: classref-enumeration + +enum **StencilMode**: :ref:`🔗` + +.. _class_BaseMaterial3D_constant_STENCIL_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilMode` **STENCIL_MODE_DISABLED** = ``0`` + +禁用模板运算。 + +.. _class_BaseMaterial3D_constant_STENCIL_MODE_OUTLINE: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilMode` **STENCIL_MODE_OUTLINE** = ``1`` + +模板预设，为物体添加轮廓。 + +\ **注意：**\ 需要自动应用 :ref:`Material.next_pass` 材质。修改模板属性或重新加载场景时，对 :ref:`Material.next_pass` 的手动更改会丢失。要安全地对使用模板预设的材质应用 :ref:`Material.next_pass` 材质，请改用 :ref:`GeometryInstance3D.material_overlay`\ 。 + +.. _class_BaseMaterial3D_constant_STENCIL_MODE_XRAY: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilMode` **STENCIL_MODE_XRAY** = ``2`` + +模板预设，为墙后的物体显示剪影。 + +\ **注意：**\ 需要自动应用 :ref:`Material.next_pass` 材质。修改模板属性或重新加载场景时，对 :ref:`Material.next_pass` 的手动更改会丢失。要安全地对使用模板预设的材质应用 :ref:`Material.next_pass` 材质，请改用 :ref:`GeometryInstance3D.material_overlay`\ 。 + +.. _class_BaseMaterial3D_constant_STENCIL_MODE_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilMode` **STENCIL_MODE_CUSTOM** = ``3`` + +启用模板运算，但不使用预设。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_BaseMaterial3D_StencilFlags: + +.. rst-class:: classref-enumeration + +enum **StencilFlags**: :ref:`🔗` + +.. _class_BaseMaterial3D_constant_STENCIL_FLAG_READ: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilFlags` **STENCIL_FLAG_READ** = ``1`` + +材质仅当其通过与现有模板缓冲区值的模板比较时才会被渲染。请参阅 :ref:`StencilCompare`\ 。 + +.. _class_BaseMaterial3D_constant_STENCIL_FLAG_WRITE: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilFlags` **STENCIL_FLAG_WRITE** = ``2`` + +材质通过深度测试时会将参考值写入模板缓冲区。 + +.. _class_BaseMaterial3D_constant_STENCIL_FLAG_WRITE_DEPTH_FAIL: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilFlags` **STENCIL_FLAG_WRITE_DEPTH_FAIL** = ``4`` + +材质未通过深度测试时会将参考值写入模板缓冲区。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_BaseMaterial3D_StencilCompare: + +.. rst-class:: classref-enumeration + +enum **StencilCompare**: :ref:`🔗` + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_ALWAYS: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_ALWAYS** = ``0`` + +始终通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_LESS: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_LESS** = ``1`` + +当参考值小于现有模板值时，通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_EQUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_EQUAL** = ``2`` + +当参考值等于现有模板值时，通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_LESS_OR_EQUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_LESS_OR_EQUAL** = ``3`` + +当参考值小于或等于现有模板值时，通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_GREATER: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_GREATER** = ``4`` + +当参考值大于现有模板值时，通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_NOT_EQUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_NOT_EQUAL** = ``5`` + +当参考值不等于现有模板值时，通过模板测试。 + +.. _class_BaseMaterial3D_constant_STENCIL_COMPARE_GREATER_OR_EQUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`StencilCompare` **STENCIL_COMPARE_GREATER_OR_EQUAL** = ``6`` + +当参考值大于或等于现有模板值时，通过模板测试。 + .. rst-class:: classref-section-separator ---- @@ -1379,7 +1623,7 @@ enum **DistanceFadeMode**: :ref:`🔗` 材质的基础颜色。 -\ **注意：**\ 如果 :ref:`detail_enabled` 为 ``true`` 并且指定了 :ref:`detail_albedo` 纹理，则 :ref:`albedo_color` *不会*\ 调制细节纹理。可用于通过不指定反照率纹理并使用透明 :ref:`detail_albedo` 纹理，来为材质的部分区域着色。 +\ **注意：**\ 如果 :ref:`detail_enabled` 为 ``true`` 并且指定了 :ref:`detail_albedo` 纹理，则 :ref:`albedo_color` *不会*\ 对细节纹理调色。可用于通过不指定反照率纹理并使用透明 :ref:`detail_albedo` 纹理，来为材质的部分区域着色。 .. rst-class:: classref-item-separator @@ -1468,7 +1712,7 @@ enum **DistanceFadeMode**: :ref:`🔗` - |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) - :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) -要应用的 Alpha 抗锯齿类型。见 :ref:`AlphaAntiAliasing`\ 。 +要应用的 Alpha 抗锯齿类型。 .. rst-class:: classref-item-separator @@ -1701,6 +1945,46 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 ---- +.. _class_BaseMaterial3D_property_bent_normal_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **bent_normal_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| + +如果为 ``true``\ ，则启用弯曲法线映射。可以实现更准确的间接光照和镜面反射遮蔽效果。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_bent_normal_texture: + +.. rst-class:: classref-property + +:ref:`Texture2D` **bent_normal_texture** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| + +用于指定给定像素的入射环境光平均方向的纹理。\ :ref:`bent_normal_texture` 只使用红色和绿色通道；会忽略蓝色和 alpha 通道。从 :ref:`bent_normal_texture` 读取的法线是围绕 :ref:`Mesh` 所提供的表面法线的进行朝向的。 + +\ **注意：**\ 弯曲法线贴图与常规法线贴图不同。烘焙弯曲法线贴图时，请确保使用\ **余弦分布**\ ，弯曲法线贴图才能正常工作。 + +\ **注意：**\ 该网格必须在其顶点数据中同时定义法线和切线。否则法线贴图将无法正确渲染，只会使整个表面变暗。如果使用 :ref:`SurfaceTool` 创建几何体，可以使用 :ref:`SurfaceTool.generate_normals()` 和 :ref:`SurfaceTool.generate_tangents()` 分别自动生成法线和切线。 + +\ **注意：**\ Godot 期望弯曲法线贴图使用 X+、Y+、Z+ 坐标系。比较流行的引擎所期望的法线贴图坐标系见\ `这个页面 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_billboard_keep_scale: .. rst-class:: classref-property @@ -1729,7 +2013,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) - :ref:`BillboardMode` **get_billboard_mode**\ (\ ) -控制该对象如何面对相机。见 :ref:`BillboardMode`\ 。 +控制该对象如何面对相机。 \ **注意：**\ 公告板模式不适合 VR，因为当屏幕贴在你的头上而不是在桌子上时，相机的左右向量不是水平的。详见 `GitHub issue #41567 `__\ 。 @@ -1750,7 +2034,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 材质的混合模式。 -\ **注意：**\ 除 ``Mix`` 以外的值会强制对象进入透明管道。见 :ref:`BlendMode`\ 。 +\ **注意：**\ 除 ``Mix`` 以外的值会强制对象进入透明管道。 .. rst-class:: classref-item-separator @@ -1837,7 +2121,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_cull_mode**\ (\ value\: :ref:`CullMode`\ ) - :ref:`CullMode` **get_cull_mode**\ (\ ) -根据三角形是朝向还是背离相机，来确定要剔除三角形的哪一侧。请参阅 :ref:`CullMode`\ 。 +根据三角形是朝向还是背离相机，来确定要剔除三角形的哪一侧。 .. rst-class:: classref-item-separator @@ -1854,7 +2138,28 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_depth_draw_mode**\ (\ value\: :ref:`DepthDrawMode`\ ) - :ref:`DepthDrawMode` **get_depth_draw_mode**\ (\ ) -确定深度渲染发生的时间。参见 :ref:`DepthDrawMode`\ 。另见 :ref:`transparency`\ 。 +确定深度渲染发生的时间。另见 :ref:`transparency`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_depth_test: + +.. rst-class:: classref-property + +:ref:`DepthTest` **depth_test** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_depth_test**\ (\ value\: :ref:`DepthTest`\ ) +- :ref:`DepthTest` **get_depth_test**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +决定深度测试时使用的比较运算符。见 :ref:`DepthTest`\ 。 + +\ **注意：**\ 将 :ref:`depth_test` 设为非默认值只有用于透明材质、\ :ref:`depth_draw_mode` 为 :ref:`DEPTH_DRAW_DISABLED` 的材质时才有可见的效果。 .. rst-class:: classref-item-separator @@ -1871,9 +2176,9 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| -用于指定细节覆盖层颜色的纹理。\ :ref:`detail_albedo` 的 alpha 通道会被用作遮罩，即使该材质不透明。要将专用纹理用作遮罩，请参阅 :ref:`detail_mask`\ 。 +用于指定细节覆盖层颜色的纹理。\ :ref:`detail_albedo` 的 alpha 通道会被用作遮罩，即使该材质不透明。将专用纹理用作遮罩见 :ref:`detail_mask`\ 。 -\ **注意：**\ :ref:`detail_albedo` *不会*\ 被 :ref:`albedo_color` 调制。 +\ **注意：**\ :ref:`detail_albedo` *不会*\ 被 :ref:`albedo_color` 调色。 .. rst-class:: classref-item-separator @@ -1890,7 +2195,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_detail_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) - :ref:`BlendMode` **get_detail_blend_mode**\ (\ ) -指定 :ref:`detail_albedo` 应如何与当前 ``ALBEDO`` 混合。参阅 :ref:`BlendMode` 选项。 +指定 :ref:`detail_albedo` 应如何与当前 ``ALBEDO`` 混合。 .. rst-class:: classref-item-separator @@ -1960,7 +2265,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_detail_uv**\ (\ value\: :ref:`DetailUV`\ ) - :ref:`DetailUV` **get_detail_uv**\ (\ ) -指定细节层是使用 ``UV`` 还是 ``UV2``\ 。选项请参阅 :ref:`DetailUV`\ 。 +指定细节层是使用 ``UV`` 还是 ``UV2``\ 。 .. rst-class:: classref-item-separator @@ -1977,7 +2282,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_diffuse_mode**\ (\ value\: :ref:`DiffuseMode`\ ) - :ref:`DiffuseMode` **get_diffuse_mode**\ (\ ) -用于漫反射光散射的算法。见 :ref:`DiffuseMode`\ 。 +用于漫反射光散射的算法。 .. rst-class:: classref-item-separator @@ -2034,6 +2339,23 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 ---- +.. _class_BaseMaterial3D_property_disable_specular_occlusion: + +.. rst-class:: classref-property + +:ref:`bool` **disable_specular_occlusion** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +如果为 ``true`` 则禁用镜面反射遮蔽，即便 :ref:`ProjectSettings.rendering/reflections/specular_occlusion/enabled` 为 ``false``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_distance_fade_max_distance: .. rst-class:: classref-property @@ -2185,7 +2507,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_emission_operator**\ (\ value\: :ref:`EmissionOperator`\ ) - :ref:`EmissionOperator` **get_emission_operator**\ (\ ) -设置 :ref:`emission` 与 :ref:`emission_texture` 的交互方式。可以是加法或乘法。可选值见 :ref:`EmissionOperator` 。 +设置 :ref:`emission` 与 :ref:`emission_texture` 的交互方式。可以是加法或乘法。 .. rst-class:: classref-item-separator @@ -2219,7 +2541,26 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| -如果为 ``true``\ ，则无论距离远近，对象都以相同的大小渲染。 +如果为 ``true``\ ，则对象始终以相同的大小渲染，忽略距离。对象在屏幕上的大小与相机距离对象原点 ``1.0`` 单位时相同，忽略与相机的实际距离。\ :ref:`Camera3D` 的视野（使用正交/视锥模式时则为 :ref:`Camera3D.size`\ ）仍然会影响对象绘制的大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_fov_override: + +.. rst-class:: classref-property + +:ref:`float` **fov_override** = ``75.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_fov_override**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fov_override**\ (\ ) + +覆盖 :ref:`Camera3D` 的视场角（单位为度）。 + +\ **注意：**\ 行为与对 :ref:`Camera3D.keep_aspect` 为 :ref:`Camera3D.KEEP_HEIGHT` 的 :ref:`Camera3D` 设置视场角一致。此外，非透视相机会忽略视场角的设置，因此效果可能不正确。 .. rst-class:: classref-item-separator @@ -2961,7 +3302,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_specular_mode**\ (\ value\: :ref:`SpecularMode`\ ) - :ref:`SpecularMode` **get_specular_mode**\ (\ ) -渲染镜面反射斑点的方法。请参阅 :ref:`SpecularMode`\ 。 +渲染镜面反射斑点的方法。 \ **注意：**\ :ref:`specular_mode` 仅适用于镜面反射斑点。它不影响来自天空的镜面反射、屏幕空间反射、\ :ref:`VoxelGI`\ 、SDFGI 或 :ref:`ReflectionProbe`\ 。要同时禁用来自这些源的反射，请将 :ref:`metallic_specular` 设置为 ``0.0``\ 。 @@ -2969,6 +3310,120 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 ---- +.. _class_BaseMaterial3D_property_stencil_color: + +.. rst-class:: classref-property + +:ref:`Color` **stencil_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_effect_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_stencil_effect_color**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +模板效果的主颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_stencil_compare: + +.. rst-class:: classref-property + +:ref:`StencilCompare` **stencil_compare** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_compare**\ (\ value\: :ref:`StencilCompare`\ ) +- :ref:`StencilCompare` **get_stencil_compare**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +模板遮罩运算所使用的比较运算符。见 :ref:`StencilCompare`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_stencil_flags: + +.. rst-class:: classref-property + +:ref:`int` **stencil_flags** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_flags**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stencil_flags**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +控制模板运算行为的标志。见 :ref:`StencilFlags`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_stencil_mode: + +.. rst-class:: classref-property + +:ref:`StencilMode` **stencil_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_mode**\ (\ value\: :ref:`StencilMode`\ ) +- :ref:`StencilMode` **get_stencil_mode**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +模板效果模式。见 :ref:`StencilMode`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_stencil_outline_thickness: + +.. rst-class:: classref-property + +:ref:`float` **stencil_outline_thickness** = ``0.01`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_effect_outline_thickness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_stencil_effect_outline_thickness**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +:ref:`STENCIL_MODE_OUTLINE` 的轮廓粗细。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_stencil_reference: + +.. rst-class:: classref-property + +:ref:`int` **stencil_reference** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stencil_reference**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stencil_reference**\ (\ ) + +**实验性：** May be affected by future rendering pipeline changes. + +模板参考值（0-255）。通常是 2 的幂。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_subsurf_scatter_enabled: .. rst-class:: classref-property @@ -3133,7 +3588,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) -纹理的过滤标志。有关选项，请参阅 :ref:`TextureFilter`\ 。 +纹理的过滤标志。 \ **注意：**\ 即便这里选择了最近邻过滤，\ :ref:`heightmap_texture` 也始终使用线性过滤采样。这是为了确保高度图效果看起来符合预期。如果需要像素之间的高度过渡更加清晰，请在图像编辑器中使用最近邻过滤调整高度图纹理的大小。 @@ -3152,7 +3607,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 - |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| -纹理的重复标志。可选项见 :ref:`TextureFilter`\ 。 +如果为 ``true``\ ，则纹理会在超出纹理大小后重复。见 :ref:`FLAG_USE_TEXTURE_REPEAT`\ 。 .. rst-class:: classref-item-separator @@ -3175,6 +3630,23 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 ---- +.. _class_BaseMaterial3D_property_use_fov_override: + +.. rst-class:: classref-property + +:ref:`bool` **use_fov_override** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +如果为 ``true``\ ，则使用 :ref:`fov_override` 来覆盖 :ref:`Camera3D` 的视场角。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_use_particle_trails: .. rst-class:: classref-property @@ -3211,6 +3683,23 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 ---- +.. _class_BaseMaterial3D_property_use_z_clip_scale: + +.. rst-class:: classref-property + +:ref:`bool` **use_z_clip_scale** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +如果为 ``true``\ ，则会使用 :ref:`z_clip_scale` 将渲染的对象朝相机方向进行缩放，从而避免与墙壁等物体发生裁剪。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_uv1_offset: .. rst-class:: classref-property @@ -3417,6 +3906,23 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 如果为 ``true``\ ，则使用顶点颜色作为反射率颜色。 +.. rst-class:: classref-item-separator + +---- + +.. _class_BaseMaterial3D_property_z_clip_scale: + +.. rst-class:: classref-property + +:ref:`float` **z_clip_scale** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_z_clip_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_z_clip_scale**\ (\ ) + +将渲染的对象朝相机方向进行缩放，从而避免与墙壁等物体发生裁剪。主要用于相对于相机固定的对象，如玩家的手臂、工具等。调整该设置时，光照和阴影仍会正常工作，但 SSAO 和 SSR 等屏幕空间效果在较低的缩放值下可能会出现问题。因此，请尽量将其保持在尽可能接近 ``1.0`` 的位置。 + .. rst-class:: classref-section-separator ---- @@ -3444,7 +3950,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| :ref:`🔗` -如果指定的标志被启用，返回 ``true``\ 。选项见 :ref:`Flags` 枚举值。 +如果指定的标志已启用，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -3480,7 +3986,7 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) :ref:`🔗` -如果为 ``true``\ ，则启用指定的标志。标志是可以打开和关闭的可选行为。使用该函数一次只能启用一个标志，不能将标志枚举值像位掩码一样进行合并，一次启用或禁用多个标志。也可以通过将相应成员设置为 ``true`` 来启用标志。选项见 :ref:`Flags` 枚举值。 +如果为 ``true``\ ，则启用指定的标志。标志是可以打开和关闭的可选行为。使用该函数一次只能启用一个标志，不能将标志枚举值像位掩码一样进行合并，一次启用或禁用多个标志。也可以通过将相应成员设置为 ``true`` 来启用标志。 .. rst-class:: classref-item-separator @@ -3492,9 +3998,10 @@ Alpha 剪刀将丢弃值的阈值。较高的值将导致更多像素被丢弃 |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` -设置由 ``param`` 指定的插槽的纹理。有关可用插槽，请参阅 :ref:`TextureParam`\ 。 +设置 ``param`` 对应槽位的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_basis.rst b/classes/zh_CN/class_basis.rst index d18b70ff9c..b7b93027f4 100644 --- a/classes/zh_CN/class_basis.rst +++ b/classes/zh_CN/class_basis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Basis.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Basis.xml. .. _class_Basis: @@ -135,6 +135,8 @@ Basis +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`scaled`\ (\ scale\: :ref:`Vector3`\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`scaled_local`\ (\ scale\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`slerp`\ (\ to\: :ref:`Basis`, weight\: :ref:`float`\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdotx`\ (\ with\: :ref:`Vector3`\ ) |const| | @@ -402,14 +404,14 @@ Basis # 创建 Z 轴向下的 Basis。 var my_basis = Basis.from_euler(Vector3(TAU / 4, 0, 0)) - + print(my_basis.z) # 输出 (0.0, -1.0, 0.0) .. code-tab:: csharp // 创建 Z 轴向下的 Basis。 var myBasis = Basis.FromEuler(new Vector3(Mathf.Tau / 4.0f, 0.0f, 0.0f)); - + GD.Print(myBasis.Z); // 输出 (0.0, -1.0, 0.0) @@ -434,7 +436,7 @@ Basis .. code-tab:: gdscript var my_basis = Basis.from_scale(Vector3(2, 4, 8)) - + print(my_basis.x) # 输出 (2.0, 0.0, 0.0) print(my_basis.y) # 输出 (0.0, 4.0, 0.0) print(my_basis.z) # 输出 (0.0, 0.0, 8.0) @@ -442,7 +444,7 @@ Basis .. code-tab:: csharp var myBasis = Basis.FromScale(new Vector3(2.0f, 4.0f, 8.0f)); - + GD.Print(myBasis.X); // 输出 (2.0, 0.0, 0.0) GD.Print(myBasis.Y); // 输出 (0.0, 4.0, 0.0) GD.Print(myBasis.Z); // 输出 (0.0, 0.0, 8.0) @@ -516,7 +518,7 @@ Basis # 以任何方式旋转基都会保持其缩放。 my_basis = my_basis.rotated(Vector3.UP, TAU / 2) my_basis = my_basis.rotated(Vector3.RIGHT, TAU / 4) - + print(my_basis.get_scale()) # 输出 (2.0, 4.0, 8.0) .. code-tab:: csharp @@ -529,7 +531,7 @@ Basis // 以任何方式旋转基都会保持其缩放。 myBasis = myBasis.Rotated(Vector3.Up, Mathf.Tau / 2.0f); myBasis = myBasis.Rotated(Vector3.Right, Mathf.Tau / 4.0f); - + GD.Print(myBasis.Scale); // 输出 (2.0, 4.0, 8.0) @@ -625,7 +627,6 @@ Basis func _process(delta): basis = basis.rotated(Vector3.UP, TAU * delta) basis = basis.rotated(Vector3.RIGHT, TAU * delta) - basis = basis.orthonormalized() .. code-tab:: csharp @@ -634,8 +635,8 @@ Basis public override void _Process(double delta) { Basis = Basis.Rotated(Vector3.Up, Mathf.Tau * (float)delta) - .Rotated(Vector3.Right, Mathf.Tau * (float)delta) - .Orthonormalized(); + .Rotated(Vector3.Right, Mathf.Tau * (float)delta) + .Orthonormalized(); } @@ -661,7 +662,7 @@ Basis var my_basis = Basis.IDENTITY var angle = TAU / 2 - + my_basis = my_basis.rotated(Vector3.UP, angle) # 绕向上轴旋转（偏航）。 my_basis = my_basis.rotated(Vector3.RIGHT, angle) # 绕向右轴旋转（俯仰）。 my_basis = my_basis.rotated(Vector3.BACK, angle) # 绕向后轴旋转（滚动）。 @@ -670,7 +671,7 @@ Basis var myBasis = Basis.Identity; var angle = Mathf.Tau / 2.0f; - + myBasis = myBasis.Rotated(Vector3.Up, angle); // 绕向上轴旋转（偏航）。 myBasis = myBasis.Rotated(Vector3.Right, angle); // 绕向右轴旋转（俯仰）。 myBasis = myBasis.Rotated(Vector3.Back, angle); // 绕向后轴旋转（滚动）。 @@ -702,7 +703,7 @@ Basis Vector3(3, 3, 3) ) my_basis = my_basis.scaled(Vector3(0, 2, -2)) - + print(my_basis.x) # 输出 (0.0, 2.0, -2.0) print(my_basis.y) # 输出 (0.0, 4.0, -4.0) print(my_basis.z) # 输出 (0.0, 6.0, -6.0) @@ -715,13 +716,58 @@ Basis new Vector3(3.0f, 3.0f, 3.0f) ); myBasis = myBasis.Scaled(new Vector3(0.0f, 2.0f, -2.0f)); - + GD.Print(myBasis.X); // 输出 (0.0, 2.0, -2.0) GD.Print(myBasis.Y); // 输出 (0.0, 4.0, -4.0) GD.Print(myBasis.Z); // 输出 (0.0, 6.0, -6.0) +.. rst-class:: classref-item-separator + +---- + +.. _class_Basis_method_scaled_local: + +.. rst-class:: classref-method + +:ref:`Basis` **scaled_local**\ (\ scale\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +返回该基，其中每个轴都按给定的 ``scale`` 中的相应分量缩放。 + +该基矩阵的列乘以 ``scale`` 的分量。该操作是局部缩放（相对于自身）。 + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis( + Vector3(1, 1, 1), + Vector3(2, 2, 2), + Vector3(3, 3, 3) + ) + my_basis = my_basis.scaled_local(Vector3(0, 2, -2)) + + print(my_basis.x) # 输出 (0.0, 0.0, 0.0) + print(my_basis.y) # 输出 (4.0, 4.0, 4.0) + print(my_basis.z) # 输出 (-6.0, -6.0, -6.0) + + .. code-tab:: csharp + + var myBasis = new Basis( + new Vector3(1.0f, 1.0f, 1.0f), + new Vector3(2.0f, 2.0f, 2.0f), + new Vector3(3.0f, 3.0f, 3.0f) + ); + myBasis = myBasis.ScaledLocal(new Vector3(0.0f, 2.0f, -2.0f)); + + GD.Print(myBasis.X); // 输出 (0, 0, 0) + GD.Print(myBasis.Y); // 输出 (4, 4, 4) + GD.Print(myBasis.Z); // 输出 (-6, -6, -6) + + + .. rst-class:: classref-item-separator ---- @@ -740,10 +786,10 @@ Basis var start_basis = Basis.IDENTITY var target_basis = Basis.IDENTITY.rotated(Vector3.UP, TAU / 2) - + func _ready(): create_tween().tween_method(interpolate, 0.0, 1.0, 5.0).set_trans(Tween.TRANS_EXPO) - + func interpolate(weight): basis = start_basis.slerp(target_basis, weight) @@ -812,7 +858,7 @@ Basis Vector3(7, 8, 9) ) my_basis = my_basis.transposed() - + print(my_basis.x) # 输出 (1.0, 4.0, 7.0) print(my_basis.y) # 输出 (2.0, 5.0, 8.0) print(my_basis.z) # 输出 (3.0, 6.0, 9.0) @@ -825,7 +871,7 @@ Basis new Vector3(7.0f, 8.0f, 9.0f) ); myBasis = myBasis.Transposed(); - + GD.Print(myBasis.X); // 输出 (1.0, 4.0, 7.0) GD.Print(myBasis.Y); // 输出 (2.0, 5.0, 8.0) GD.Print(myBasis.Z); // 输出 (3.0, 6.0, 9.0) @@ -971,6 +1017,7 @@ Basis \ **注意：**\ 在 C++ 中，该运算符访问基础矩阵的行，而\ *不*\ 是列。对于与脚本语言相同的行为，请使用 ``set_column`` 和 ``get_column`` 方法。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_bitmap.rst b/classes/zh_CN/class_bitmap.rst index 2ddb91b99e..33e9c3294a 100644 --- a/classes/zh_CN/class_bitmap.rst +++ b/classes/zh_CN/class_bitmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BitMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BitMap.xml. .. _class_BitMap: @@ -227,6 +227,7 @@ BitMap 将位图中指定位置的元素设置为指定值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_bone2d.rst b/classes/zh_CN/class_bone2d.rst index 66c4b0b133..bc2f81710d 100644 --- a/classes/zh_CN/class_bone2d.rst +++ b/classes/zh_CN/class_bone2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Bone2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Bone2D.xml. .. _class_Bone2D: @@ -207,6 +207,7 @@ Bone2D 设置该 **Bone2D** 中骨骼的长度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boneattachment3d.rst b/classes/zh_CN/class_boneattachment3d.rst index 12c56fff03..c4539afcd9 100644 --- a/classes/zh_CN/class_boneattachment3d.rst +++ b/classes/zh_CN/class_boneattachment3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoneAttachment3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneAttachment3D.xml. .. _class_BoneAttachment3D: @@ -32,13 +32,19 @@ BoneAttachment3D .. table:: :widths: auto - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`bone_idx` | ``-1`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`bone_name` | ``""`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`override_pose` | ``false`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bone_idx` | ``-1`` | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`bone_name` | ``""`` | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`external_skeleton` | | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`override_pose` | ``false`` | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_external_skeleton` | ``false`` | + +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -48,19 +54,11 @@ BoneAttachment3D .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_external_skeleton`\ (\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_use_external_skeleton`\ (\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`on_skeleton_update`\ (\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_external_skeleton`\ (\ external_skeleton\: :ref:`NodePath`\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_use_external_skeleton`\ (\ use_external_skeleton\: :ref:`bool`\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------+ + | |void| | :ref:`on_skeleton_update`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -105,6 +103,23 @@ BoneAttachment3D ---- +.. _class_BoneAttachment3D_property_external_skeleton: + +.. rst-class:: classref-property + +:ref:`NodePath` **external_skeleton** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_external_skeleton**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_external_skeleton**\ (\ ) + +指向外部 :ref:`Skeleton3D` 节点的 :ref:`NodePath`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_BoneAttachment3D_property_override_pose: .. rst-class:: classref-property @@ -116,10 +131,27 @@ BoneAttachment3D - |void| **set_override_pose**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_override_pose**\ (\ ) -BoneAttachment3D 节点是否会覆盖所附着骨骼的骨骼姿势。设置为 ``true`` 时，BoneAttachment3D 节点能够更改骨骼的姿势。设置为 ``false`` 时，BoneAttachment3D 始终为该骨骼的变换。 +**BoneAttachment3D** 节点是否会覆盖所附着骨骼的骨骼姿势。设置为 ``true`` 时，\ **BoneAttachment3D** 节点能够更改骨骼的姿势。设置为 ``false`` 时，\ **BoneAttachment3D** 始终为该骨骼的变换。 \ **注意：**\ 由于固有的设计，覆盖是在骨架更新的过程中使用信号打断执行的。与 :ref:`SkeletonModifier3D` 一起使用时可能会造成预料之外的行为。 +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneAttachment3D_property_use_external_skeleton: + +.. rst-class:: classref-property + +:ref:`bool` **use_external_skeleton** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_use_external_skeleton**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_external_skeleton**\ (\ ) + +设置 **BoneAttachment3D** 节点是否使用外部 :ref:`Skeleton3D` 节点，而不是尝试使用其父节点作为 :ref:`Skeleton3D`\ 。当设置为 ``true`` 时，\ **BoneAttachment3D** 节点将使用 :ref:`external_skeleton` 中设置的外部 :ref:`Skeleton3D` 节点。 + .. rst-class:: classref-section-separator ---- @@ -129,37 +161,13 @@ BoneAttachment3D 节点是否会覆盖所附着骨骼的骨骼姿势。设置为 方法说明 -------- -.. _class_BoneAttachment3D_method_get_external_skeleton: - -.. rst-class:: classref-method - -:ref:`NodePath` **get_external_skeleton**\ (\ ) |const| :ref:`🔗` - -返回到外部 :ref:`Skeleton3D` 节点的 :ref:`NodePath`\ （如果已设置）。 - -.. rst-class:: classref-item-separator - ----- - .. _class_BoneAttachment3D_method_get_skeleton: .. rst-class:: classref-method :ref:`Skeleton3D` **get_skeleton**\ (\ ) :ref:`🔗` -存在 :ref:`Skeleton3D` 类型的父节点或外部节点时将其返回。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_BoneAttachment3D_method_get_use_external_skeleton: - -.. rst-class:: classref-method - -:ref:`bool` **get_use_external_skeleton**\ (\ ) |const| :ref:`🔗` - -返回该 BoneAttachment3D 节点是否正在使用外部 :ref:`Skeleton3D`\ ，而不是尝试将其父节点用作 :ref:`Skeleton3D`\ 。 +如果存在父级或外部 :ref:`Skeleton3D` 节点则将其返回，否则返回 ``null``\ 。 .. rst-class:: classref-item-separator @@ -173,31 +181,8 @@ BoneAttachment3D 节点是否会覆盖所附着骨骼的骨骼姿势。设置为 当 :ref:`Skeleton3D` 被更新时自动调用的函数。该函数是 **BoneAttachment3D** 节点更新其位置的地方，以便在\ *未*\ 设置为覆盖骨骼姿势时正确绑定。 -.. rst-class:: classref-item-separator - ----- - -.. _class_BoneAttachment3D_method_set_external_skeleton: - -.. rst-class:: classref-method - -|void| **set_external_skeleton**\ (\ external_skeleton\: :ref:`NodePath`\ ) :ref:`🔗` - -设置该 BoneAttachment3D 节点到其应使用的外部骨架的 :ref:`NodePath`\ 。请参阅 :ref:`set_use_external_skeleton()` 以启用外部 :ref:`Skeleton3D` 节点。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_BoneAttachment3D_method_set_use_external_skeleton: - -.. rst-class:: classref-method - -|void| **set_use_external_skeleton**\ (\ use_external_skeleton\: :ref:`bool`\ ) :ref:`🔗` - -设置该 BoneAttachment3D 节点是否将使用外部 :ref:`Skeleton3D` 节点，而不是尝试使用其父节点作为 :ref:`Skeleton3D`\ 。当设置为 ``true`` 时，BoneAttachment3D 节点将使用 :ref:`set_external_skeleton()` 中设置的外部 :ref:`Skeleton3D` 节点。 - .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boneconstraint3d.rst b/classes/zh_CN/class_boneconstraint3d.rst new file mode 100644 index 0000000000..96c1b8fa4f --- /dev/null +++ b/classes/zh_CN/class_boneconstraint3d.rst @@ -0,0 +1,239 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneConstraint3D.xml. + +.. _class_BoneConstraint3D: + +BoneConstraint3D +================ + +**继承：** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**派生：** :ref:`AimModifier3D`, :ref:`ConvertTransformModifier3D`, :ref:`CopyTransformModifier3D` + +能够修改 Skeleton3D 中骨骼对两根骨骼进行关联的节点。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +:ref:`SkeletonModifier3D` 的基类，能够根据 :ref:`get_reference_bone()` 所获得骨骼的变换修改 :ref:`set_apply_bone()` 中设置的骨骼。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_setting`\ (\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_amount`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_apply_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_apply_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_setting_count`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_amount`\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting_count`\ (\ count\: :ref:`int`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_BoneConstraint3D_method_clear_setting: + +.. rst-class:: classref-method + +|void| **clear_setting**\ (\ ) :ref:`🔗` + +清空所有设置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_amount: + +.. rst-class:: classref-method + +:ref:`float` **get_amount**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的应用量。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_apply_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_apply_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的应用骨骼。骨骼会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_apply_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_apply_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的应用骨骼名称。骨骼会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_reference_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_reference_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的参考骨骼。 + +修改器只会参考该骨骼，不会对其进行修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_reference_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_reference_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的参考骨骼名称。 + +修改器只会参考该骨骼，不会对其进行修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_setting_count: + +.. rst-class:: classref-method + +:ref:`int` **get_setting_count**\ (\ ) |const| :ref:`🔗` + +返回修改器中的设置数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_amount: + +.. rst-class:: classref-method + +|void| **set_amount**\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的应用量设置为 ``amount``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_apply_bone: + +.. rst-class:: classref-method + +|void| **set_apply_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的应用骨骼设置为 ``bone``\ 。骨骼会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_apply_bone_name: + +.. rst-class:: classref-method + +|void| **set_apply_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的应用骨骼名称设置为 ``bone_name``\ 。骨骼会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_reference_bone: + +.. rst-class:: classref-method + +|void| **set_reference_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的参考骨骼设置为 ``bone``\ 。 + +修改器只会参考该骨骼，不会对其进行修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_reference_bone_name: + +.. rst-class:: classref-method + +|void| **set_reference_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的参考骨骼名称设置为 ``bone_name``\ 。 + +修改器只会参考该骨骼，不会对其进行修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_setting_count: + +.. rst-class:: classref-method + +|void| **set_setting_count**\ (\ count\: :ref:`int`\ ) :ref:`🔗` + +设置修改器中的设置数。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_bonemap.rst b/classes/zh_CN/class_bonemap.rst index 94fb9a05e0..092a42b18d 100644 --- a/classes/zh_CN/class_bonemap.rst +++ b/classes/zh_CN/class_bonemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoneMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneMap.xml. .. _class_BoneMap: @@ -157,6 +157,7 @@ BoneMap 在重定向过程中，设置的骨骼名称是源骨架中骨骼的名称。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_bool.rst b/classes/zh_CN/class_bool.rst index 033829244d..e820948115 100644 --- a/classes/zh_CN/class_bool.rst +++ b/classes/zh_CN/class_bool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/bool.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/bool.xml. .. _class_bool: @@ -51,7 +51,7 @@ bool if bullets > 0 and not is_reloading(): launch_bullet() - + if bullets == 0 or is_reloading(): play_clack_sound() @@ -61,7 +61,7 @@ bool { LaunchBullet(); } - + if (bullets == 0 || IsReloading()) { PlayClackSound(); @@ -210,6 +210,7 @@ bool 如果左操作数为 ``true`` 且右操作数为 ``false``\ ，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boxcontainer.rst b/classes/zh_CN/class_boxcontainer.rst index 313d139d08..7193a3c88a 100644 --- a/classes/zh_CN/class_boxcontainer.rst +++ b/classes/zh_CN/class_boxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxContainer.xml. .. _class_BoxContainer: @@ -183,6 +183,7 @@ enum **AlignmentMode**: :ref:`🔗` **BoxContainer** 元素之间的距离，单位为像素。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boxmesh.rst b/classes/zh_CN/class_boxmesh.rst index b46214f968..0ac1839499 100644 --- a/classes/zh_CN/class_boxmesh.rst +++ b/classes/zh_CN/class_boxmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoxMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxMesh.xml. .. _class_BoxMesh: @@ -117,6 +117,7 @@ BoxMesh 沿 X 轴插入的额外边缘环的数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boxoccluder3d.rst b/classes/zh_CN/class_boxoccluder3d.rst index ec07aa0bb1..fc4442db9b 100644 --- a/classes/zh_CN/class_boxoccluder3d.rst +++ b/classes/zh_CN/class_boxoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoxOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxOccluder3D.xml. .. _class_BoxOccluder3D: @@ -65,6 +65,7 @@ BoxOccluder3D 以 3D 单位表示的盒子大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_boxshape3d.rst b/classes/zh_CN/class_boxshape3d.rst index 96230e0729..78180086cd 100644 --- a/classes/zh_CN/class_boxshape3d.rst +++ b/classes/zh_CN/class_boxshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/BoxShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxShape3D.xml. .. _class_BoxShape3D: @@ -69,6 +69,7 @@ BoxShape3D 该盒子的宽度、高度和深度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_button.rst b/classes/zh_CN/class_button.rst index 9f158f994e..0dd362aa2d 100644 --- a/classes/zh_CN/class_button.rst +++ b/classes/zh_CN/class_button.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Button.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Button.xml. .. _class_Button: @@ -35,7 +35,7 @@ Button button.text = "Click me" button.pressed.connect(_button_pressed) add_child(button) - + func _button_pressed(): print("Hello world!") @@ -48,7 +48,7 @@ Button button.Pressed += ButtonPressed; AddChild(button); } - + private void ButtonPressed() { GD.Print("Hello world!"); @@ -82,6 +82,8 @@ Button +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``128`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`expand_icon` | ``false`` | @@ -197,7 +199,7 @@ Button - |void| **set_text_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_text_alignment**\ (\ ) -按钮文本的文本对齐策略，使用 :ref:`HorizontalAlignment` 常量之一。 +按钮文本的文本对齐策略。 .. rst-class:: classref-item-separator @@ -220,6 +222,23 @@ Button ---- +.. _class_Button_property_autowrap_trim_flags: + +.. rst-class:: classref-property + +|bitfield|\[:ref:`LineBreakFlag`\] **autowrap_trim_flags** = ``128`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +自动换行空格修剪标志。详见 :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` 和 :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_property_clip_text: .. rst-class:: classref-property @@ -369,7 +388,7 @@ Button - |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) - :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) -设置文本超出节点的边界矩形时的裁剪行为。有关所有模式的描述，请参阅 :ref:`OverrunBehavior`\ 。 +设置文本超出节点边界框时的裁剪行为。 .. rst-class:: classref-item-separator @@ -487,7 +506,7 @@ Button :ref:`Color` **icon_disabled_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗` -该 **Button** 处于禁用状态时，使用的图标调制 :ref:`Color`\ 。 +该 **Button** 处于禁用状态时，使用的图标调色 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -499,7 +518,7 @@ Button :ref:`Color` **icon_focus_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` -该 **Button** 处于聚焦状态时，使用的图标调制 :ref:`Color`\ 。仅替换该按钮的正常调制颜色。禁用、悬停和按下状态优先于这个颜色。 +该 **Button** 处于聚焦状态时，使用的图标调色 :ref:`Color`\ 。仅替换该按钮的正常调制颜色。禁用、悬停和按下状态优先于这个颜色。 .. rst-class:: classref-item-separator @@ -511,7 +530,7 @@ Button :ref:`Color` **icon_hover_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` -该 **Button** 处于悬停状态时，使用的图标调制\ :ref:`Color`\ 。 +该 **Button** 处于悬停状态时，使用的图标调色 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -523,7 +542,7 @@ Button :ref:`Color` **icon_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` -该 **Button** 处于悬停并按下按下状态时，使用的图标调制 :ref:`Color`\ 。 +该 **Button** 处于悬停并按下按下状态时，使用的图标调色 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -535,7 +554,7 @@ Button :ref:`Color` **icon_normal_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` -该 **Button** 的默认图标调制 :ref:`Color`\ 。 +该 **Button** 的默认图标调色 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -547,7 +566,7 @@ Button :ref:`Color` **icon_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` -该 **Button** 处于按下状态时，使用的图标调制 :ref:`Color`\ 。 +该 **Button** 处于按下状态时，使用的图标调色 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -780,6 +799,7 @@ Button 该 **Button** 处于按下状态时使用的 :ref:`StyleBox`\ （用于从右至左布局）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_buttongroup.rst b/classes/zh_CN/class_buttongroup.rst index 1bb68b7a29..f8bffe5e61 100644 --- a/classes/zh_CN/class_buttongroup.rst +++ b/classes/zh_CN/class_buttongroup.rst @@ -1,9 +1,12 @@ :github_url: hide +.. meta:: + :keywords: radio + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ButtonGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ButtonGroup.xml. .. _class_ButtonGroup: @@ -120,6 +123,7 @@ ButtonGroup 返回当前按下的按钮。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_callable.rst b/classes/zh_CN/class_callable.rst index 70ff1378d3..68b0aeab5d 100644 --- a/classes/zh_CN/class_callable.rst +++ b/classes/zh_CN/class_callable.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Callable.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Callable.xml. .. _class_Callable: @@ -26,7 +26,7 @@ Callable func print_args(arg1, arg2, arg3 = ""): prints(arg1, arg2, arg3) - + func test(): var callable = Callable(self, "print_args") callable.call("hello", "world") # 输出“hello world ”。 @@ -40,7 +40,7 @@ Callable { GD.PrintS(arg1, arg2, arg3); } - + public void Test() { // Invalid calls fail silently. @@ -59,10 +59,10 @@ GDScript 中可以在方法里创建 lambda 函数。Lambda 函数是自定义 func _init(): var my_lambda = func (message): print(message) - + # 输出“大家好呀！” my_lambda.call("大家好呀！") - + # 发出 button_pressed 信号时输出“全军出击！”。 button_pressed.connect(func(): print("全军出击！")) @@ -78,11 +78,11 @@ GDScript 中可以在方法里创建 lambda 函数。Lambda 函数是自定义 :: - var dictionary = {"hello": "world"} - + var dictionary = { "hello": "world" } + # 不行，“clear” 被视为一个键。 tween.tween_callback(dictionary.clear) - + # 有效。 tween.tween_callback(Callable.create(dictionary, "clear")) @@ -557,6 +557,7 @@ GDScript 中可以在方法里创建 lambda 函数。Lambda 函数是自定义 如果两个 **Callable** 调用的自定义目标相同，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_callbacktweener.rst b/classes/zh_CN/class_callbacktweener.rst index f689cabfd0..c6b28c62be 100644 --- a/classes/zh_CN/class_callbacktweener.rst +++ b/classes/zh_CN/class_callbacktweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CallbackTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CallbackTweener.xml. .. _class_CallbackTweener: @@ -62,6 +62,7 @@ CallbackTweener tween.tween_callback(queue_free).set_delay(2) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_camera2d.rst b/classes/zh_CN/class_camera2d.rst index e3f941848a..44ec9eea92 100644 --- a/classes/zh_CN/class_camera2d.rst +++ b/classes/zh_CN/class_camera2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Camera2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Camera2D.xml. .. _class_Camera2D: @@ -25,7 +25,7 @@ Camera2D 这个节点旨在成为简单的辅助工具，让事情便捷，但可能需要更多的功能来改变相机的工作方式。要制作自定义相机节点，则从 :ref:`Node2D` 继承，并通过设置 :ref:`Viewport` 中的 :ref:`Viewport.canvas_transform` 来改变画布的变换（你可以通过使用 :ref:`Node.get_viewport()` 获得当前的 :ref:`Viewport`\ ）。 -请注意，\ **Camera2D** 节点的 ``position`` 并不代表屏幕的实际位置，这可能会因应用的平滑或限制而有所不同。可以使用 :ref:`get_screen_center_position()` 获取真实位置。 +请注意，\ **Camera2D** 节点的 :ref:`Node2D.global_position` 并不代表屏幕的实际位置，这可能会因应用的平滑或限制而有所不同。可以使用 :ref:`get_screen_center_position()` 获取真实位置。该节点的 :ref:`Node2D.global_rotation` 亦然，可能由于应用的旋转平滑而有所不同。可以使用 :ref:`get_screen_rotation()` 获取屏幕的当前旋转值。 .. rst-class:: classref-introduction-group @@ -77,6 +77,8 @@ Camera2D +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_bottom` | ``10000000`` | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`limit_enabled` | ``true`` | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_left` | ``-10000000`` | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_right` | ``10000000`` | @@ -119,6 +121,8 @@ Camera2D +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_screen_center_position`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_screen_rotation`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_target_position`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_current`\ (\ ) |const| | @@ -209,7 +213,7 @@ enum **Camera2DProcessCallback**: :ref:`🔗`\ ) - :ref:`AnchorMode` **get_anchor_mode**\ (\ ) -Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 +Camera2D 的锚点。 .. rst-class:: classref-item-separator @@ -476,6 +480,23 @@ Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 ---- +.. _class_Camera2D_property_limit_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **limit_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_limit_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_limit_enabled**\ (\ ) + +如果为 ``true`` 则启用限制。禁用该选项将允许相机聚焦在任何位置，此时四个 ``limit_*`` 属性不起作用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera2D_property_limit_left: .. rst-class:: classref-property @@ -610,7 +631,7 @@ Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 - |void| **set_process_callback**\ (\ value\: :ref:`Camera2DProcessCallback`\ ) - :ref:`Camera2DProcessCallback` **get_process_callback**\ (\ ) -该相机的处理回调。见 :ref:`Camera2DProcessCallback`\ 。 +相机的处理回调。 .. rst-class:: classref-item-separator @@ -663,7 +684,7 @@ Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 - |void| **set_zoom**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_zoom**\ (\ ) -相机的缩放。 设置为 ``Vector(2, 2)`` 的缩放值会使通过视口看到的尺寸翻倍。设置为 ``Vector(0.5, 0.5)``\ 的缩放值会使会使通过视口看到的尺寸减半。 +相机的缩放。值越高，放大效果越明显。例如，\ ``Vector2(2.0, 2.0)`` 的缩放将在各个轴上放大两倍（视图覆盖的区域缩小四倍）。相反，\ ``Vector2(0.5, 0.5)`` 的缩放将在各个轴上缩小两倍（视图覆盖的区域扩大四倍）。X 和 Y 分量通常应始终设置为相同的值，除非你希望拉伸相机视图。 \ **注意：**\ :ref:`FontFile.oversampling` *不会*\ 考虑 **Camera2D** 的缩放值。这意味着放大/缩小将导致位图字体和光栅化（非 MSDF）动态字体看起来模糊或像素化，除非字体是\ :ref:`CanvasLayer`\ 的一部分从而使其忽略相机缩放。为了确保文本无论如何缩放都保持清晰，你可以通过启用 :ref:`ProjectSettings.gui/theme/default_font_multichannel_signed_distance_field` （仅适用于默认项目字体）来启用 MSDF 字体渲染，或在自定义字体的动态字体导入选项中启用\ **多通道带符号距离场**\ 。对于系统字体，可以在检查器中启用 :ref:`SystemFont.multichannel_signed_distance_field` 。 @@ -738,6 +759,20 @@ Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 ---- +.. _class_Camera2D_method_get_screen_rotation: + +.. rst-class:: classref-method + +:ref:`float` **get_screen_rotation**\ (\ ) |const| :ref:`🔗` + +从该相机的视角返回当前的屏幕旋转。 + +\ **注意：**\ 如果相机由于 :ref:`rotation_smoothing_enabled` 平滑旋转，则屏幕旋转可能与 :ref:`Node2D.global_rotation` 不同。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera2D_method_get_target_position: .. rst-class:: classref-method @@ -811,6 +846,7 @@ Camera2D 的锚点。见 :ref:`AnchorMode` 常量。 设置指定边 :ref:`Side` 的相机极限。另见 :ref:`limit_bottom`\ 、\ :ref:`limit_top`\ 、\ :ref:`limit_left` 和 :ref:`limit_right`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_camera3d.rst b/classes/zh_CN/class_camera3d.rst index 1f09ea351c..da3ad42937 100644 --- a/classes/zh_CN/class_camera3d.rst +++ b/classes/zh_CN/class_camera3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Camera3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Camera3D.xml. .. _class_Camera3D: @@ -313,7 +313,9 @@ enum **DopplerTracking**: :ref:`🔗` - |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking`\ ) - :ref:`DopplerTracking` **get_doppler_tracking**\ (\ ) -如果不是 :ref:`DOPPLER_TRACKING_DISABLED`\ ，此相机将为在 ``_process`` 中变化的对象模拟\ `多普勒效应 `__\ 。可能的值见 :ref:`DopplerTracking`\ 。 +如果不是 :ref:`DOPPLER_TRACKING_DISABLED`\ ，此相机将为在 ``_process`` 中变化的对象模拟\ `多普勒效应 `__\ 。 + +\ **注意：**\ 仅当 :ref:`AudioStreamPlayer3D.doppler_tracking` 未设置为 :ref:`AudioStreamPlayer3D.DOPPLER_TRACKING_DISABLED` 时，才会在 :ref:`AudioStreamPlayer3D` 上听到多普勒效果。 .. rst-class:: classref-item-separator @@ -706,7 +708,9 @@ enum **DopplerTracking**: :ref:`🔗` |void| **set_orthogonal**\ (\ size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` -通过指定的以世界空间单位为单位的 ``size``\ 、以及 ``z_near`` 和 ``z_far`` 裁剪平面，将相机投影设置为正交模式（参见 :ref:`PROJECTION_ORTHOGONAL`\ ）。（作为提示，2D 游戏经常使用这种投影，其值以像素为单位指定。） +通过指定的以世界空间单位为单位的 ``size``\ 、以及 ``z_near`` 和 ``z_far`` 裁剪平面，将相机投影设置为正交模式（参见 :ref:`PROJECTION_ORTHOGONAL`\ ）。 + +作为提示，看起来像 2D 的 3D 游戏经常使用这种投影，其中 ``size`` 以像素为单位指定。 .. rst-class:: classref-item-separator @@ -742,6 +746,7 @@ enum **DopplerTracking**: :ref:`🔗` control.position = get_viewport().get_camera_3d().unproject_position(global_transform.origin) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cameraattributes.rst b/classes/zh_CN/class_cameraattributes.rst index e364cca657..037619f027 100644 --- a/classes/zh_CN/class_cameraattributes.rst +++ b/classes/zh_CN/class_cameraattributes.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraAttributes.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributes.xml. .. _class_CameraAttributes: @@ -144,6 +144,7 @@ CameraAttributes \ **注意：**\ 仅在启用 :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` 时可用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cameraattributesphysical.rst b/classes/zh_CN/class_cameraattributesphysical.rst index aca2fdd035..d5e6a091bc 100644 --- a/classes/zh_CN/class_cameraattributesphysical.rst +++ b/classes/zh_CN/class_cameraattributesphysical.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraAttributesPhysical.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPhysical.xml. .. _class_CameraAttributesPhysical: @@ -235,6 +235,7 @@ CameraAttributesPhysical 返回对应于 :ref:`frustum_focal_length` 的垂直视野。每当 :ref:`frustum_focal_length` 发生变化时，该值都会在内部计算。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cameraattributespractical.rst b/classes/zh_CN/class_cameraattributespractical.rst index 43ed0146cb..c81e912467 100644 --- a/classes/zh_CN/class_cameraattributespractical.rst +++ b/classes/zh_CN/class_cameraattributespractical.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraAttributesPractical.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPractical.xml. .. _class_CameraAttributesPractical: @@ -214,6 +214,7 @@ CameraAttributesPractical 当为正数时，距离超过该值且截止到 :ref:`dof_blur_near_distance` 时，模糊效果将从 0 缩放到 :ref:`dof_blur_amount`\ 。当为负数时，使用基于物理的缩放，因此景深效果将在 :ref:`dof_blur_near_distance` 处从 0 开始缩放，并且随着对象靠近该 :ref:`Camera3D`\ ，将以物理上准确的方式增加该效果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_camerafeed.rst b/classes/zh_CN/class_camerafeed.rst index b3a161a08e..06a2ca8dce 100644 --- a/classes/zh_CN/class_camerafeed.rst +++ b/classes/zh_CN/class_camerafeed.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraFeed.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraFeed.xml. .. _class_CameraFeed: @@ -19,11 +19,11 @@ CameraFeed 描述 ---- -通过相机源，你可以访问连接到设备的单个物理相机。启用后，Godot 将开始从相机捕获帧，随后这些帧便可使用。另见 :ref:`CameraServer`\ 。 +通过相机源，你可以访问连接到设备的某个物理相机。启用后，Godot 将开始从相机捕获帧，随后这些帧便可使用。另见 :ref:`CameraServer`\ 。 \ **注意：**\ 很多相机会返回 YCbCr 图像，这些图像被分成两个纹理，需要在着色器中组合。如果你将环境设置为在背景中显示相机图像，Godot 会自动执行此操作。 -\ **注意：**\ 这个类目前只在 Linux、macOS 和 iOS 上实现。在其他平台上没有可用的 **CameraFeed**\ 。在 iOS 上获取 **CameraFeed** 需要来自 `godot-ios-plugins `__ 的相机插件。 +\ **注意：**\ 这个类目前只在 Linux、Android、macOS 和 iOS 上实现。在其他平台上没有可用的 **CameraFeed**\ 。在 iOS 上获取 **CameraFeed** 需要 `godot-ios-plugins `__ 中的相机插件。 .. rst-class:: classref-reftable-group @@ -361,13 +361,13 @@ enum **FeedPosition**: :ref:`🔗` :ref:`bool` **set_format**\ (\ index\: :ref:`int`, parameters\: :ref:`Dictionary`\ ) :ref:`🔗` -为源格式数组 :ref:`formats` 中给定索引的元素设置格式参数。成功则返回 ``true``\ 。默认会将 YUYV 编码的流转换为 FEED_RGB。YUYV 编码的流的输出格式可以使用 ``parameters``.output 修改： +设置 :ref:`formats` 数组中给定 ``index`` 的源格式参数。成功时返回 ``true``\ 。默认情况下，YUYV 编码的流会转换为 :ref:`FEED_RGB`\ 。YUYV 编码的流的输出格式可以通过将 ``parameters`` 的 ``output`` 条目设置为以下之一来更改： -\ ``separate`` 得到的是 FEED_YCBCR_SEP +- ``"separate"`` 得到的是 :ref:`FEED_YCBCR_SEP`\ ； -\ ``grayscale`` 得到的是降低饱和度的 FEED_RGB +- ``"grayscale"`` 得到的是降低饱和度的 :ref:`FEED_RGB`\ ； -\ ``copy`` 得到的是 FEED_YCBCR +- ``"copy"`` 得到的是 :ref:`FEED_YCBCR`\ 。 .. rst-class:: classref-item-separator @@ -418,6 +418,7 @@ enum **FeedPosition**: :ref:`🔗` 设置该源的 YCbCr 图像。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cameraserver.rst b/classes/zh_CN/class_cameraserver.rst index e6a0791a90..34f4497a9c 100644 --- a/classes/zh_CN/class_cameraserver.rst +++ b/classes/zh_CN/class_cameraserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraServer.xml. .. _class_CameraServer: @@ -23,7 +23,19 @@ CameraServer 主要用于为 AR 模块提供来自相机的视频源。 -\ **注意：**\ 这个类目前只在 Linux、macOS 和 iOS 上实现。在其他平台上没有可用的 :ref:`CameraFeed`\ 。在 iOS 上获取 :ref:`CameraFeed` 需要来自 `godot-ios-plugins `__ 的相机插件。 +\ **注意：**\ 这个类目前只在 Linux、Android、macOS 和 iOS 上实现。在其他平台上没有可用的 :ref:`CameraFeed`\ 。在 iOS 上获取 :ref:`CameraFeed` 需要 `godot-ios-plugins `__ 中的相机插件。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------+-----------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`monitoring_feeds` | ``false`` | + +-------------------------+-----------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -74,6 +86,18 @@ CameraServer 当移除 :ref:`CameraFeed` 时发出（例如拔掉网络摄像头时）。 +.. rst-class:: classref-item-separator + +---- + +.. _class_CameraServer_signal_camera_feeds_updated: + +.. rst-class:: classref-signal + +**camera_feeds_updated**\ (\ ) :ref:`🔗` + +Emitted when camera feeds are updated. + .. rst-class:: classref-section-separator ---- @@ -121,6 +145,59 @@ Y 分量相机图像。 CbCr 分量相机图像。 +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_CameraServer_property_monitoring_feeds: + +.. rst-class:: classref-property + +:ref:`bool` **monitoring_feeds** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_monitoring_feeds**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitoring_feeds**\ (\ ) + +If ``true``, the server is actively monitoring available camera feeds. + +This has a performance cost, so only set it to ``true`` when you're actively accessing the camera. + +\ **Note:** After setting it to ``true``, you can receive updated camera feeds through the :ref:`camera_feeds_updated` signal. + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + CameraServer.camera_feeds_updated.connect(_on_camera_feeds_updated) + CameraServer.monitoring_feeds = true + + func _on_camera_feeds_updated(): + var feeds = CameraServer.feeds() + + .. code-tab:: csharp + + public override void _Ready() + { + CameraServer.CameraFeedsUpdated += OnCameraFeedsUpdated; + CameraServer.MonitoringFeeds = true; + } + + void OnCameraFeedsUpdated() + { + var feeds = CameraServer.Feeds(); + } + + + .. rst-class:: classref-section-separator ---- @@ -187,6 +264,7 @@ CbCr 分量相机图像。 移除指定的相机源 ``feed``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cameratexture.rst b/classes/zh_CN/class_cameratexture.rst index 10f7e2cc80..2453db4bde 100644 --- a/classes/zh_CN/class_cameratexture.rst +++ b/classes/zh_CN/class_cameratexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CameraTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraTexture.xml. .. _class_CameraTexture: @@ -98,6 +98,7 @@ CameraTexture 我们要访问 :ref:`CameraFeed` 中的哪个图像，如果相机图像被分割成 Y 和 CbCr 分量，这一点很重要。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvasgroup.rst b/classes/zh_CN/class_canvasgroup.rst index 5b6d8e646c..1b6fedee7c 100644 --- a/classes/zh_CN/class_canvasgroup.rst +++ b/classes/zh_CN/class_canvasgroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasGroup.xml. .. _class_CanvasGroup: @@ -27,16 +27,16 @@ CanvasGroup shader_type canvas_item; render_mode unshaded; - + uniform sampler2D screen_texture : hint_screen_texture, repeat_disable, filter_nearest; - + void fragment() { vec4 c = textureLod(screen_texture, SCREEN_UV, 0.0); - + if (c.a > 0.0001) { c.rgb /= c.a; } - + COLOR *= c; } @@ -115,6 +115,7 @@ CanvasGroup 如果为 ``true``\ ，则会在绘制该 **CanvasGroup** 之前为其后台缓冲计算 mipmap，附加到该 **CanvasGroup** 的自定义 :ref:`ShaderMaterial` 就可以使用 mipmap。Mipmap 的生成会造成性能消耗，所以应在必要时才启用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvasitem.rst b/classes/zh_CN/class_canvasitem.rst index 137c23d3d5..ac8b9c3185 100644 --- a/classes/zh_CN/class_canvasitem.rst +++ b/classes/zh_CN/class_canvasitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasItem.xml. .. _class_CanvasItem: @@ -90,127 +90,127 @@ CanvasItem .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_draw`\ (\ ) |virtual| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_animation_slice`\ (\ animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_arc`\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_char`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_char_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_circle`\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_colored_polygon`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_dashed_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_end_animation`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_lcd_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_mesh`\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_msdf_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multimesh`\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_polygon`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_polyline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_polyline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_primitive`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_rect`\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_set_transform`\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_set_transform_matrix`\ (\ xform\: :ref:`Transform2D`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_style_box`\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_texture`\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_texture_rect`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`force_update_transform`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_canvas`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_canvas_item`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CanvasLayer` | :ref:`get_canvas_layer_node`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_canvas_transform`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_global_mouse_position`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_global_transform`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_global_transform_with_canvas`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_instance_shader_parameter`\ (\ name\: :ref:`StringName`\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_local_mouse_position`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_screen_transform`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_transform`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_viewport_rect`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_viewport_transform`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_visibility_layer_bit`\ (\ layer\: :ref:`int`\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`World2D` | :ref:`get_world_2d`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`hide`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_local_transform_notification_enabled`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_transform_notification_enabled`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`make_canvas_position_local`\ (\ viewport_point\: :ref:`Vector2`\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InputEvent` | :ref:`make_input_local`\ (\ event\: :ref:`InputEvent`\ ) |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_to_front`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`queue_redraw`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_instance_shader_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_notify_local_transform`\ (\ enable\: :ref:`bool`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_notify_transform`\ (\ enable\: :ref:`bool`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_visibility_layer_bit`\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`show`\ (\ ) | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw`\ (\ ) |virtual| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_animation_slice`\ (\ animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_arc`\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_char`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_char_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_circle`\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_colored_polygon`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dashed_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_end_animation`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_lcd_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_mesh`\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_msdf_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multimesh`\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polygon`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polyline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polyline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_primitive`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_rect`\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_set_transform`\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_set_transform_matrix`\ (\ xform\: :ref:`Transform2D`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_style_box`\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture`\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture_rect`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_transform`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_canvas`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_canvas_item`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CanvasLayer` | :ref:`get_canvas_layer_node`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_canvas_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_global_mouse_position`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_global_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_global_transform_with_canvas`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_instance_shader_parameter`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_local_mouse_position`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_screen_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_viewport_rect`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_viewport_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_visibility_layer_bit`\ (\ layer\: :ref:`int`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`World2D` | :ref:`get_world_2d`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hide`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_local_transform_notification_enabled`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_transform_notification_enabled`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`make_canvas_position_local`\ (\ viewport_point\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`InputEvent` | :ref:`make_input_local`\ (\ event\: :ref:`InputEvent`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_to_front`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_redraw`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_shader_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_local_transform`\ (\ enable\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_transform`\ (\ enable\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_visibility_layer_bit`\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -241,7 +241,7 @@ CanvasItem **hidden**\ (\ ) :ref:`🔗` -当 **CanvasItem** 隐藏时发出，即不再在树中可见（见 :ref:`is_visible_in_tree()`\ ）。 +当该节点隐藏时发出，即不再在树中可见（见 :ref:`is_visible_in_tree()`\ ）。 .. rst-class:: classref-item-separator @@ -267,6 +267,8 @@ CanvasItem 在 **CanvasItem** 的可见性改变时发射，这种改变或是因为其自身的 :ref:`visible` 属性发生了变化，或是因为其在树中的可见性发生了变化（见 :ref:`is_visible_in_tree()`\ ）。 +该信号在相关的 :ref:`NOTIFICATION_VISIBILITY_CHANGED` 通知\ *之后*\ 发出。 + .. rst-class:: classref-section-separator ---- @@ -378,7 +380,7 @@ enum **TextureRepeat**: :ref:`🔗` :ref:`TextureRepeat` **TEXTURE_REPEAT_DISABLED** = ``1`` -纹理不会重复。 +纹理不会重复。在纹理范围之外采样会导致边缘像素“拉伸”。你可以通过确保在纹理两侧各有一个 1 像素的完全透明边框来避免这种情况。 .. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED: @@ -386,7 +388,7 @@ enum **TextureRepeat**: :ref:`🔗` :ref:`TextureRepeat` **TEXTURE_REPEAT_ENABLED** = ``2`` -纹理将正常重复。 +纹理会在超出纹理大小后重复。 .. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR: @@ -394,7 +396,7 @@ enum **TextureRepeat**: :ref:`🔗` :ref:`TextureRepeat` **TEXTURE_REPEAT_MIRROR** = ``3`` -纹理将以 2×2 平铺模式重复，其中偶数位置的元素会被镜像。 +纹理会在超出纹理大小后以“2×2 平铺模式”重复。偶数位置的重复纹理会被镜像。 .. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX: @@ -420,7 +422,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`ClipChildrenMode` **CLIP_CHILDREN_DISABLED** = ``0`` -子级绘制在父级之上，不会被裁剪。 +子节点绘制在该节点之上，不会被裁剪。 .. _class_CanvasItem_constant_CLIP_CHILDREN_ONLY: @@ -428,7 +430,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`ClipChildrenMode` **CLIP_CHILDREN_ONLY** = ``1`` -父级仅用于裁剪目的。子级被裁剪到父级的可见区域，不绘制父级。 +该节点用作遮罩，\ **不进行**\ 绘制。遮罩基于该节点的 Alpha 通道：保留不透明像素，丢弃透明像素，半透明像素根据不透明度混合。子节点受到该节点绘制区域的裁剪。 .. _class_CanvasItem_constant_CLIP_CHILDREN_AND_DRAW: @@ -436,7 +438,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`ClipChildrenMode` **CLIP_CHILDREN_AND_DRAW** = ``2`` -父级用于裁剪子级，但在将子级剪裁到其可见区域之前，父级也像往常一样绘制在子级下方。 +该节点用作遮罩，也会进行绘制。遮罩基于该节点的 Alpha 通道：保留不透明像素，丢弃透明像素，半透明像素根据不透明度混合。子节点受到该节点绘制区域的裁剪。 .. _class_CanvasItem_constant_CLIP_CHILDREN_MAX: @@ -461,7 +463,9 @@ enum **ClipChildrenMode**: :ref:`🔗` **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` -该 **CanvasItem** 的全局变换已更改。只有在通过 :ref:`set_notify_transform()` 启用时，才会收到这个通知。 +:ref:`is_transform_notification_enabled()` 为 ``true`` 时，节点的全局变换发生改变时收到的通知。另见 :ref:`set_notify_transform()` 和 :ref:`get_transform()`\ 。 + +\ **注意：**\ :ref:`Camera2D`\ 、\ :ref:`CollisionObject2D` 等许多画布项会自动启用此功能以确保正常运行。 .. _class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED: @@ -469,7 +473,9 @@ enum **ClipChildrenMode**: :ref:`🔗` **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` :ref:`🔗` -该 **CanvasItem** 的局部变换已更改。只有在通过 :ref:`set_notify_local_transform()` 启用时，才会收到这个通知。 +:ref:`is_local_transform_notification_enabled()` 为 ``true`` 时，节点的变换发生改变时收到的通知。父级 :ref:`Node2D` 的变换发生改变时不会收到该通知。另见 :ref:`set_notify_local_transform()`\ 。 + +\ **注意：**\ :ref:`Camera2D`\ 、\ :ref:`CollisionShape2D` 等许多画布项会自动启用此功能以确保正常运行。 .. _class_CanvasItem_constant_NOTIFICATION_DRAW: @@ -485,7 +491,9 @@ enum **ClipChildrenMode**: :ref:`🔗` **NOTIFICATION_VISIBILITY_CHANGED** = ``31`` :ref:`🔗` -该 **CanvasItem** 的可见性已更改。 +节点的可见性发生改变时收到的通知（见 :ref:`visible` 和 :ref:`is_visible_in_tree()`\ ）。 + +该通知会在相关 :ref:`visibility_changed` 信号\ *之前*\ 收到。 .. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS: @@ -509,7 +517,7 @@ enum **ClipChildrenMode**: :ref:`🔗` **NOTIFICATION_WORLD_2D_CHANGED** = ``36`` :ref:`🔗` -该 **CanvasItem** 的活动 :ref:`World2D` 已更改。 +该 **CanvasItem** 注册至新的 :ref:`World2D` 时收到的通知（见 :ref:`get_world_2d()`\ ）。 .. rst-class:: classref-section-separator @@ -531,9 +539,9 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_clip_children_mode**\ (\ value\: :ref:`ClipChildrenMode`\ ) - :ref:`ClipChildrenMode` **get_clip_children_mode**\ (\ ) -允许当前节点裁剪子节点，本质上相当于遮罩。 +该节点作为遮罩对子节点进行裁剪的模式。 -\ **注意：**\ 节点裁剪无法嵌套，也不能位于 :ref:`CanvasGroup` 范围内。如果该节点的祖先节点裁剪了它的子级，或者祖先节点是 :ref:`CanvasGroup`\ ，那么这个节点的裁剪模式应当设为 :ref:`CLIP_CHILDREN_DISABLED`\ ，从而避免意外行为。 +\ **注意：**\ 裁剪的节点无法嵌套，也不能位于 :ref:`CanvasGroup` 中。如果该节点的祖先节点裁剪了它的子级，或者祖先节点是 :ref:`CanvasGroup`\ ，那么这个节点的裁剪模式应当设为 :ref:`CLIP_CHILDREN_DISABLED`\ ，从而避免意外行为。 .. rst-class:: classref-item-separator @@ -603,7 +611,7 @@ enum **ClipChildrenMode**: :ref:`🔗` 应用于这个 **CanvasItem** 的颜色。这个属性\ **不会**\ 影响子级 **CanvasItem**\ ，与会同时影响节点自身和子级的 :ref:`modulate` 不同。 -\ **注意：**\ 内部子节点（例如 :ref:`ColorPicker` 中的滑块、\ :ref:`TabContainer` 中的选项卡栏）也不受这个属性的影响（见 :ref:`Node.get_child()` 等类似方法的 ``include_internal`` 参数）。 +\ **注意：**\ 内部子节点也不受这个属性的影响（见 :ref:`Node.add_child()` 方法的 ``include_internal`` 参数）。内置节点的内部子节点包括 :ref:`ColorPicker` 中的滑块、\ :ref:`TabContainer` 中的选项卡栏等。 .. rst-class:: classref-item-separator @@ -620,7 +628,7 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_draw_behind_parent**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_behind_parent_enabled**\ (\ ) -如果为 ``true``\ ，则对象在其父对象后面绘制。 +如果为 ``true``\ ，则该节点绘制在其父节点后面。 .. rst-class:: classref-item-separator @@ -637,7 +645,7 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) -在该 **CanvasItem** 上使用的纹理过滤模式。 +渲染该 **CanvasItem** 的纹理时使用的过滤模式。 .. rst-class:: classref-item-separator @@ -654,7 +662,9 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) - :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) -在该 **CanvasItem** 上使用的纹理重复模式。 +用于渲染该 **CanvasItem** 纹理的重复模式。它会影响在纹理范围之外采样时发生的情况，例如，设置比纹理大的 :ref:`Sprite2D.region_rect` 或在纹理外部分配 :ref:`Polygon2D` UV 点。 + +\ **注意：**\ :ref:`TextureRect` 不受 :ref:`texture_repeat` 的影响，因为它使用自己的纹理重复实现。 .. rst-class:: classref-item-separator @@ -688,7 +698,7 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_use_parent_material**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_use_parent_material**\ (\ ) -如果为 ``true``\ ，则将父级 **CanvasItem** 的 :ref:`material` 属性用作此项的材质。 +如果为 ``true``\ ，则将父级 **CanvasItem** 的 :ref:`material` 属性用作该节点的材质。 .. rst-class:: classref-item-separator @@ -762,7 +772,9 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_z_as_relative**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_z_relative**\ (\ ) -如果为 ``true``\ ，节点的 Z 索引是相对于它的父节点的 Z 索引而言的。如果这个节点的 Z 索引是 2，它的父节点的实际 Z 索引是 3，那么这个节点的实际 Z 索引将是 2 + 3 = 5。 +如果为 ``true``\ ，则该节点的最终 Z 索引是相对于父节点的 Z 索引而言的。 + +例如 :ref:`z_index` 为 ``2``\ 、父节点的最终 Z 索引为 ``3``\ ，那么该节点的最终 Z 索引就是 ``5``\ （\ ``2 + 3``\ ）。 .. rst-class:: classref-item-separator @@ -779,9 +791,9 @@ enum **ClipChildrenMode**: :ref:`🔗` - |void| **set_z_index**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_index**\ (\ ) -控制节点的渲染顺序。具有较高 Z 索引的节点将显示在其他节点的前面。必须在 :ref:`RenderingServer.CANVAS_ITEM_Z_MIN` 和 :ref:`RenderingServer.CANVAS_ITEM_Z_MAX`\ 之间（包含）。 +节点的绘制顺序。Z 索引较高的节点会显示在其他节点的前面。必须在 :ref:`RenderingServer.CANVAS_ITEM_Z_MIN` 和 :ref:`RenderingServer.CANVAS_ITEM_Z_MAX` 之间（含两端）。 -\ **注意：**\ 改变 :ref:`Control` 的 Z 索引只影响绘图顺序，不影响处理输入事件的顺序。可用于实现某些 UI 动画，例如对处于悬停状态的菜单项进行缩放，此时会与其他内容重叠。 +\ **注意：**\ Z 索引\ **不会**\ 影响 **CanvasItem** 节点的处理顺序和输入事件的处理顺序。\ :ref:`Control` 节点尤其需要注意这一点。 .. rst-class:: classref-section-separator @@ -838,9 +850,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用自定义字体绘制字符串的第一个字符。 +使用自定义字体绘制字符串中的第一个字符。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -850,9 +862,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用自定义字体绘制字符串中第一个字符的轮廓。 +使用自定义字体绘制字符串中第一个字符的轮廓。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -1023,9 +1035,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -将 ``text`` 分成几行，并在 ``pos``\ （左上角）处使用指定的 ``font`` 绘制文本。该文本的颜色将乘以 ``modulate``\ 。如果 ``width`` 大于等于 0，则当该文本超过指定宽度时将被裁剪。 +使用 ``font`` 字体分若干行绘制 ``text`` 文本，以 ``pos`` 作为左上角。文本颜色会与 ``modulate`` 相乘。如果 ``width`` 大于等于 0，则文本超出该宽度的部分会被裁剪。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -1035,9 +1047,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -将 ``text`` 分成几行，并在 ``pos``\ （左上角）处使用指定的 ``font`` 绘制文本轮廓。该文本的颜色将乘以 ``modulate``\ 。如果 ``width`` 大于等于 0，则当该文本超过指定宽度时将被裁剪。 +使用 ``font`` 字体分若干行绘制 ``text`` 文本的轮廓，以 ``pos`` 作为左上角。文本颜色会与 ``modulate`` 相乘。如果 ``width`` 大于等于 0，则文本超出该宽度的部分会被裁剪。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -1159,9 +1171,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用指定的 ``font`` 在 ``pos``\ （使用的字体的基线的左下角）处绘制 ``text``\ 。该文本的颜色将乘以 ``modulate``\ 。如果 ``width`` 大于等于 0，则文本超过指定宽度将被裁剪。 +使用 ``font`` 字体绘制 ``text`` 文本，以 ``pos`` 作为左下角，对齐字体基线。文本颜色会与 ``modulate`` 相乘。如果 ``width`` 大于等于 0，则文本超出该宽度的部分会被裁剪。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 \ **示例：**\ 使用项目默认字体绘制“Hello world”： @@ -1198,9 +1210,9 @@ enum **ClipChildrenMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在 ``pos``\ （左下角使用字体的基线）处使用指定的 ``font`` 绘制 ``text`` 轮廓。该文本的颜色将乘以 ``modulate``\ 。如果 ``width`` 大于等于 0，则当文本超过指定宽度时将被裁剪。 +使用 ``font`` 字体绘制 ``text`` 文本的轮廓，以 ``pos`` 作为左下角，对齐字体基线。文本颜色会与 ``modulate`` 相乘。如果 ``width`` 大于等于 0，则文本超出该宽度的部分会被裁剪。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -1260,7 +1272,9 @@ enum **ClipChildrenMode**: :ref:`🔗` |void| **force_update_transform**\ (\ ) :ref:`🔗` -强制更新变换。由于性能原因，物理中的变换改变不是即时的。变换是在累积后再设置。如果你在进行物理操作时需要最新的变换，请使用此功能。 +强制更新节点的变换。如果节点不在树中则失败。另见 :ref:`get_transform()`\ 。 + +\ **注意：**\ 出于性能考虑，通常会对变换的更新进行累积，在帧结束时应用\ *一次*\ 。更新也会沿着 **CanvasItem** 子节点传播。因此只应在确实需要最新的变换时使用该方法（例如进行物理运算）。 .. rst-class:: classref-item-separator @@ -1272,7 +1286,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`RID` **get_canvas**\ (\ ) |const| :ref:`🔗` -返回此项目所在的 :ref:`World2D` 画布的 :ref:`RID`\ 。 +返回该节点注册到的 :ref:`World2D` 画布的 :ref:`RID`\ ，适用于 :ref:`RenderingServer`\ 。 .. rst-class:: classref-item-separator @@ -1284,7 +1298,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`RID` **get_canvas_item**\ (\ ) |const| :ref:`🔗` -返回 :ref:`RenderingServer` 对该项目使用的画布项目 RID。 +返回 :ref:`RenderingServer` 对该项目使用的画布项目 :ref:`RID`\ 。 .. rst-class:: classref-item-separator @@ -1308,7 +1322,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`Transform2D` **get_canvas_transform**\ (\ ) |const| :ref:`🔗` -返回从该项目所在的画布坐标系到 :ref:`Viewport` 坐标系的变换。 +返回节点的变换，从所在画布的坐标系转换至所在视口的坐标系。另见 :ref:`Node.get_viewport()`\ 。 .. rst-class:: classref-item-separator @@ -1320,9 +1334,9 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`Vector2` **get_global_mouse_position**\ (\ ) |const| :ref:`🔗` -返回该 **CanvasItem** 所在的 :ref:`CanvasLayer` 中鼠标的位置，使用该 :ref:`CanvasLayer` 的坐标系。 +返回鼠标光标的全局位置，相对于包含该节点的 :ref:`CanvasLayer`\ 。 -\ **注意：**\ 要得到屏幕空间的坐标（例如使用非嵌入式 :ref:`Popup` 时），你可以使用 :ref:`DisplayServer.mouse_get_position()`\ 。 +\ **注意：**\ 要得到屏幕空间的坐标（例如使用非嵌入式 :ref:`Popup` 时）可以使用 :ref:`DisplayServer.mouse_get_position()`\ 。 .. rst-class:: classref-item-separator @@ -1396,7 +1410,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`Transform2D` **get_transform**\ (\ ) |const| :ref:`🔗` -返回此项目的变换矩阵。 +返回该 **CanvasItem** 的变换矩阵。 .. rst-class:: classref-item-separator @@ -1408,7 +1422,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`Rect2` **get_viewport_rect**\ (\ ) |const| :ref:`🔗` -以 :ref:`Rect2` 形式返回视口的边界。 +以 :ref:`Rect2` 的形式返回该节点的视口边界。另见 :ref:`Node.get_viewport()`\ 。 .. rst-class:: classref-item-separator @@ -1420,7 +1434,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`Transform2D` **get_viewport_transform**\ (\ ) |const| :ref:`🔗` -返回从该项目所在的画布坐标系到 :ref:`Viewport` 嵌入坐标系的变换。 +返回该节点的变换，从所注册画布的坐标系转换至视口嵌入器的坐标系。另见 :ref:`Viewport.get_final_transform()` 和 :ref:`Node.get_viewport()`\ 。 .. rst-class:: classref-item-separator @@ -1432,7 +1446,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`bool` **get_visibility_layer_bit**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` -返回渲染可见层上的某个比特位。 +如果 :ref:`visibility_layer` 中设置了给定索引对应的层，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1444,7 +1458,9 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`World2D` **get_world_2d**\ (\ ) |const| :ref:`🔗` -返回此物品所在的 :ref:`World2D`\ 。 +返回该节点注册到的 :ref:`World2D`\ 。 + +通常与该节点的视口相同（见 :ref:`Node.get_viewport()` 和 :ref:`Viewport.find_world_2d()`\ ）。 .. rst-class:: classref-item-separator @@ -1468,7 +1484,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -如果将局部变换通知传达给子级，则返回 ``true``\ 。 +如果节点会在局部变换发生改变时收到 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` 则返回 ``true``\ 。使用 :ref:`set_notify_local_transform()` 启用。 .. rst-class:: classref-item-separator @@ -1480,7 +1496,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -如果将全局变换通知传达给子级，则返回 ``true``\ 。 +如果节点会在全局变换发生改变时收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED` 则返回 ``true``\ 。使用 :ref:`set_notify_transform()` 启用。 .. rst-class:: classref-item-separator @@ -1526,7 +1542,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`InputEvent` **make_input_local**\ (\ event\: :ref:`InputEvent`\ ) |const| :ref:`🔗` -``event`` 的输入发出的变换将在局部空间而不是全局空间中应用。 +返回 ``event`` 事件的副本，将其坐标从全局空间转换至该 **CanvasItem** 的局部空间。无法转换则原样返回 :ref:`InputEvent`\ 。 .. rst-class:: classref-item-separator @@ -1538,9 +1554,7 @@ enum **ClipChildrenMode**: :ref:`🔗` |void| **move_to_front**\ (\ ) :ref:`🔗` -移动该节点以显示在其同级节点之上。 - -在内部，该节点被移动到父节点的子节点列表的底部。该方法对没有父节点的节点没有影响。 +将该节点移至同级节点的下方，通常会导致该节点绘制在同级节点的上方。如果该节点没有父节点则不会发生任何事情。另见 :ref:`Node.move_child()`\ 。 .. rst-class:: classref-item-separator @@ -1580,7 +1594,9 @@ enum **ClipChildrenMode**: :ref:`🔗` |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -如果 ``enable`` 为 ``true``\ ，则该节点将在其局部变换发生改变时收到 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`\ 。 +如果为 ``true``\ ，则该节点将在其局部变换发生改变时收到 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`\ 。 + +\ **注意：**\ :ref:`Bone2D`\ 、\ :ref:`CollisionShape2D` 等许多画布项都会自动启用，从而正常工作。 .. rst-class:: classref-item-separator @@ -1592,7 +1608,9 @@ enum **ClipChildrenMode**: :ref:`🔗` |void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -如果 ``enable`` 为 ``true``\ ，那么这个节点会在其全局变换发生改变时接收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED`\ 。 +如果为 ``true``\ ，则该节点将在其全局变换发生改变时收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED`\ 。 + +\ **注意：**\ :ref:`Camera2D`\ 、\ :ref:`Light2D` 等许多画布项都会自动启用，从而正常工作。 .. rst-class:: classref-item-separator @@ -1616,9 +1634,12 @@ enum **ClipChildrenMode**: :ref:`🔗` |void| **show**\ (\ ) :ref:`🔗` -如果该 **CanvasItem** 目前是隐藏的，则将其显示。相当于将 :ref:`visible` 设为 ``true``\ 。对于继承自 :ref:`Popup` 的控件，让它们可见的正确做法是换成调用各种 ``popup*()`` 函数的其中之一。 +如果该 **CanvasItem** 目前是隐藏的，则将其显示。相当于将 :ref:`visible` 设为 ``true``\ 。 + +\ **注意：**\ 对于继承自 :ref:`Popup` 的控件，让它们可见的正确做法是换成调用各种 ``popup*()`` 函数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvasitemmaterial.rst b/classes/zh_CN/class_canvasitemmaterial.rst index 2663aa77e8..82cf61a361 100644 --- a/classes/zh_CN/class_canvasitemmaterial.rst +++ b/classes/zh_CN/class_canvasitemmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasItemMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasItemMaterial.xml. .. _class_CanvasItemMaterial: @@ -248,6 +248,7 @@ enum **LightMode**: :ref:`🔗` 这个属性（以及其他依赖它的 ``particles_anim_*`` 属性）对其他类型的节点没有影响。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvaslayer.rst b/classes/zh_CN/class_canvaslayer.rst index a5c9ca2b85..f668e8efe3 100644 --- a/classes/zh_CN/class_canvaslayer.rst +++ b/classes/zh_CN/class_canvaslayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasLayer.xml. .. _class_CanvasLayer: @@ -140,7 +140,7 @@ CanvasLayer - |void| **set_follow_viewport**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_following_viewport**\ (\ ) -启用时，\ **CanvasLayer** 会保持在屏幕上的某个固定位置。禁用时，\ **CanvasLayer** 会保持世界空间中的位置。 +启用时，\ **CanvasLayer** 会保持在世界空间中的位置。禁用时，\ **CanvasLayer** 会保持在屏幕上的某个固定位置。 与 :ref:`follow_viewport_scale` 配合可以实现伪 3D 效果。 @@ -180,6 +180,8 @@ CanvasLayer \ **注意：**\ 如果多个 CanvasLayer 的画布层索引相同，一个 CanvasLayer 的 :ref:`CanvasItem` 子节点都会绘制在另一个 CanvasLayer 的 :ref:`CanvasItem` 子节点之后。哪个 CanvasLayer 画在前面并不一定。 +\ **注意：**\ 画布层索引应当在 :ref:`RenderingServer.CANVAS_LAYER_MIN` 和 :ref:`RenderingServer.CANVAS_LAYER_MAX` 之间（含两端）。其他值都会发生环绕。 + .. rst-class:: classref-item-separator ---- @@ -321,6 +323,7 @@ CanvasLayer 显示该 **CanvasLayer** 下的所有 :ref:`CanvasItem`\ 。相当于将 :ref:`visible` 设为 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvasmodulate.rst b/classes/zh_CN/class_canvasmodulate.rst index 922c52b3cb..df5b600266 100644 --- a/classes/zh_CN/class_canvasmodulate.rst +++ b/classes/zh_CN/class_canvasmodulate.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasModulate.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasModulate.xml. .. _class_CanvasModulate: @@ -66,6 +66,7 @@ CanvasModulate 要应用的色调颜色。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_canvastexture.rst b/classes/zh_CN/class_canvastexture.rst index 5dc652ec75..a3dcaee88b 100644 --- a/classes/zh_CN/class_canvastexture.rst +++ b/classes/zh_CN/class_canvastexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CanvasTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasTexture.xml. .. _class_CanvasTexture: @@ -183,6 +183,7 @@ CanvasTexture 绘制该 **CanvasTexture** 时所使用的纹理重复模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_capsulemesh.rst b/classes/zh_CN/class_capsulemesh.rst index a4160d221c..2b1ead5565 100644 --- a/classes/zh_CN/class_capsulemesh.rst +++ b/classes/zh_CN/class_capsulemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CapsuleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleMesh.xml. .. _class_CapsuleMesh: @@ -59,7 +59,9 @@ CapsuleMesh - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -胶囊网格的总高度（包括半球形末端）。 +胶囊体网格的总高度（包括半球形末端）。 + +\ **注意：**\ 胶囊体的 :ref:`height` 必须至少为其 :ref:`radius` 的两倍。否则，胶囊体将变为圆形。如果 :ref:`height` 小于 :ref:`radius` 的两倍，则属性将调整为有效值。 .. rst-class:: classref-item-separator @@ -93,7 +95,9 @@ CapsuleMesh - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) -胶囊网格的半径。 +胶囊体网格的半径。 + +\ **注意：**\ 胶囊体的 :ref:`radius` 不能大于其 :ref:`height` 的一半。否则，胶囊体将变成圆形。如果 :ref:`radius` 大于 :ref:`height` 的一半，则属性将调整为有效值。 .. rst-class:: classref-item-separator @@ -113,6 +117,7 @@ CapsuleMesh 沿胶囊高度的环数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_capsuleshape2d.rst b/classes/zh_CN/class_capsuleshape2d.rst index ac8e4c512b..3340292c0c 100644 --- a/classes/zh_CN/class_capsuleshape2d.rst +++ b/classes/zh_CN/class_capsuleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CapsuleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleShape2D.xml. .. _class_CapsuleShape2D: @@ -31,11 +31,13 @@ CapsuleShape2D .. table:: :widths: auto - +---------------------------+-----------------------------------------------------+----------+ - | :ref:`float` | :ref:`height` | ``30.0`` | - +---------------------------+-----------------------------------------------------+----------+ - | :ref:`float` | :ref:`radius` | ``10.0`` | - +---------------------------+-----------------------------------------------------+----------+ + +---------------------------+-------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`height` | ``30.0`` | + +---------------------------+-------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`mid_height` | | + +---------------------------+-------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`radius` | ``10.0`` | + +---------------------------+-------------------------------------------------------------+----------+ .. rst-class:: classref-section-separator @@ -57,7 +59,26 @@ CapsuleShape2D - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -胶囊体的高度。 +胶囊的总高度，包括半圆。 + +\ **注意：**\ 胶囊的 :ref:`height` 必须至少为其 :ref:`radius` 的两倍。否则，胶囊将变为圆形。如果 :ref:`height` 小于 :ref:`radius` 的两倍，则属性将调整为有效值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CapsuleShape2D_property_mid_height: + +.. rst-class:: classref-property + +:ref:`float` **mid_height** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mid_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mid_height**\ (\ ) + +胶囊的高度，不包括两个半圆。这是胶囊中间矩形部分的高度，即两个半圆圆心之间的距离。这是对 :ref:`height` 的封装。 .. rst-class:: classref-item-separator @@ -74,9 +95,12 @@ CapsuleShape2D - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) -胶囊体的半径。 +胶囊的半径。 + +\ **注意：**\ 胶囊的 :ref:`radius` 不能大于其 :ref:`height` 的一半。否则，胶囊将变成圆形。如果 :ref:`radius` 大于 :ref:`height` 的一半，则属性将调整为有效值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_capsuleshape3d.rst b/classes/zh_CN/class_capsuleshape3d.rst index bc59367b57..093693ad9b 100644 --- a/classes/zh_CN/class_capsuleshape3d.rst +++ b/classes/zh_CN/class_capsuleshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CapsuleShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleShape3D.xml. .. _class_CapsuleShape3D: @@ -38,11 +38,13 @@ CapsuleShape3D .. table:: :widths: auto - +---------------------------+-----------------------------------------------------+---------+ - | :ref:`float` | :ref:`height` | ``2.0`` | - +---------------------------+-----------------------------------------------------+---------+ - | :ref:`float` | :ref:`radius` | ``0.5`` | - +---------------------------+-----------------------------------------------------+---------+ + +---------------------------+-------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`height` | ``2.0`` | + +---------------------------+-------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`mid_height` | | + +---------------------------+-------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`radius` | ``0.5`` | + +---------------------------+-------------------------------------------------------------+---------+ .. rst-class:: classref-section-separator @@ -64,7 +66,26 @@ CapsuleShape3D - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -胶囊体的高度。 +胶囊体的总高度，包括半球。 + +\ **注意：**\ 胶囊体的 :ref:`height` 必须至少为其 :ref:`radius` 的两倍。否则，胶囊体将变为球体。如果 :ref:`height` 小于 :ref:`radius` 的两倍，则属性将调整为有效值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CapsuleShape3D_property_mid_height: + +.. rst-class:: classref-property + +:ref:`float` **mid_height** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mid_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mid_height**\ (\ ) + +胶囊的高度，不包括两个半球。这是胶囊中间圆柱部分的高度，即两个半球球心之间的距离。这是对 :ref:`height` 的封装。 .. rst-class:: classref-item-separator @@ -83,7 +104,10 @@ CapsuleShape3D 胶囊体的半径。 +\ **注意：**\ 胶囊体的 :ref:`radius` 不能大于其 :ref:`height` 的一半。否则，胶囊体将变为球体。如果 :ref:`radius` 大于 :ref:`height` 的一半，则属性将调整为有效值。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_centercontainer.rst b/classes/zh_CN/class_centercontainer.rst index 2712634996..1693175ace 100644 --- a/classes/zh_CN/class_centercontainer.rst +++ b/classes/zh_CN/class_centercontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CenterContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CenterContainer.xml. .. _class_CenterContainer: @@ -63,6 +63,7 @@ CenterContainer 如果为 ``true``\ ，会将子节点相对于 **CenterContainer** 的左上角居中。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_characterbody2d.rst b/classes/zh_CN/class_characterbody2d.rst index b09123e851..7c1c14ab92 100644 --- a/classes/zh_CN/class_characterbody2d.rst +++ b/classes/zh_CN/class_characterbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CharacterBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharacterBody2D.xml. .. _class_CharacterBody2D: @@ -28,6 +28,10 @@ CharacterBody2D 教程 ---- +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - :doc:`运动学角色（2D） <../tutorials/physics/kinematic_character_2d>` - :doc:`使用 CharacterBody2D <../tutorials/physics/using_character_body_2d>` @@ -49,7 +53,7 @@ CharacterBody2D +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ | :ref:`bool` | :ref:`floor_constant_speed` | ``false`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ - | :ref:`float` | :ref:`floor_max_angle` | ``0.785398`` | + | :ref:`float` | :ref:`floor_max_angle` | ``0.7853982`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ | :ref:`float` | :ref:`floor_snap_length` | ``1.0`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ @@ -73,7 +77,7 @@ CharacterBody2D +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ | :ref:`Vector2` | :ref:`velocity` | ``Vector2(0, 0)`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ - | :ref:`float` | :ref:`wall_min_slide_angle` | ``0.261799`` | + | :ref:`float` | :ref:`wall_min_slide_angle` | ``0.2617994`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+ .. rst-class:: classref-reftable-group @@ -236,7 +240,7 @@ enum **PlatformOnLeave**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **floor_max_angle** = ``0.785398`` :ref:`🔗` +:ref:`float` **floor_max_angle** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +302,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_max_slides**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_max_slides**\ (\ ) -调用 :ref:`move_and_slide()` 时，该物体在停止之前可以改变方向的最大次数。 +调用 :ref:`move_and_slide()` 时，物体在停止之前可以改变方向的最大次数。必须大于零。 .. rst-class:: classref-item-separator @@ -315,7 +319,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_motion_mode**\ (\ value\: :ref:`MotionMode`\ ) - :ref:`MotionMode` **get_motion_mode**\ (\ ) -设置运动模式，定义 :ref:`move_and_slide()` 的行为。可用的模式见 :ref:`MotionMode` 常量。 +设置运动模式，定义 :ref:`move_and_slide()` 的行为。 .. rst-class:: classref-item-separator @@ -349,7 +353,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_platform_on_leave**\ (\ value\: :ref:`PlatformOnLeave`\ ) - :ref:`PlatformOnLeave` **get_platform_on_leave**\ (\ ) -设置离开移动平台时要应用的行为。为了达到物理准确，默认会应用你离开时最后的平台速度。可用的行为见 :ref:`PlatformOnLeave` 常量。 +设置离开移动平台时要应用的行为。为了达到物理准确，默认会应用你离开时最后的平台速度。 .. rst-class:: classref-item-separator @@ -450,14 +454,14 @@ enum **PlatformOnLeave**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗` +:ref:`float` **wall_min_slide_angle** = ``0.2617994`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_wall_min_slide_angle**\ (\ ) -该物体遇到斜面时，允许滑动的最小角度（单位为弧度）。默认值等于 15 度。只有在 :ref:`motion_mode` 为 :ref:`MOTION_MODE_FLOATING` 时，该属性才会影响运动。 +物体遇到墙面时允许发生滑动的最小角度（单位为弧度）。默认值等于 15 度。只有在 :ref:`motion_mode` 为 :ref:`MOTION_MODE_FLOATING` 时该属性才会影响运动。 .. rst-class:: classref-section-separator @@ -714,6 +718,7 @@ enum **PlatformOnLeave**: :ref:`🔗` 如果该物体发生了碰撞，则返回 ``true``\ ，否则返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_characterbody3d.rst b/classes/zh_CN/class_characterbody3d.rst index 1af592c458..8d1ae4e2ca 100644 --- a/classes/zh_CN/class_characterbody3d.rst +++ b/classes/zh_CN/class_characterbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CharacterBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharacterBody3D.xml. .. _class_CharacterBody3D: @@ -28,6 +28,10 @@ CharacterBody3D 教程 ---- +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - :doc:`运动学角色（2D） <../tutorials/physics/kinematic_character_2d>` - `3D 动力学角色演示 `__ @@ -51,7 +55,7 @@ CharacterBody3D +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`floor_constant_speed` | ``false`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ - | :ref:`float` | :ref:`floor_max_angle` | ``0.785398`` | + | :ref:`float` | :ref:`floor_max_angle` | ``0.7853982`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`floor_snap_length` | ``0.1`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ @@ -75,7 +79,7 @@ CharacterBody3D +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`velocity` | ``Vector3(0, 0, 0)`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ - | :ref:`float` | :ref:`wall_min_slide_angle` | ``0.261799`` | + | :ref:`float` | :ref:`wall_min_slide_angle` | ``0.2617994`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -240,7 +244,7 @@ enum **PlatformOnLeave**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **floor_max_angle** = ``0.785398`` :ref:`🔗` +:ref:`float` **floor_max_angle** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -302,7 +306,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_max_slides**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_max_slides**\ (\ ) -调用 :ref:`move_and_slide()` 时，该物体在停止之前可以改变方向的最大次数。 +调用 :ref:`move_and_slide()` 时，物体在停止之前可以改变方向的最大次数。必须大于零。 .. rst-class:: classref-item-separator @@ -319,7 +323,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_motion_mode**\ (\ value\: :ref:`MotionMode`\ ) - :ref:`MotionMode` **get_motion_mode**\ (\ ) -设置运动模式，定义 :ref:`move_and_slide()` 的行为。可用的模式见 :ref:`MotionMode` 常量。 +设置运动模式，定义 :ref:`move_and_slide()` 的行为。 .. rst-class:: classref-item-separator @@ -353,7 +357,7 @@ enum **PlatformOnLeave**: :ref:`🔗` - |void| **set_platform_on_leave**\ (\ value\: :ref:`PlatformOnLeave`\ ) - :ref:`PlatformOnLeave` **get_platform_on_leave**\ (\ ) -设置离开移动平台时要应用的行为。为了达到物理准确，默认会应用你离开时最后的平台速度。可用的行为见 :ref:`PlatformOnLeave` 常量。 +设置离开移动平台时要应用的行为。为了达到物理准确，默认会应用你离开时最后的平台速度。 .. rst-class:: classref-item-separator @@ -454,14 +458,14 @@ enum **PlatformOnLeave**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗` +:ref:`float` **wall_min_slide_angle** = ``0.2617994`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_wall_min_slide_angle**\ (\ ) -该物体遇到斜面时，允许滑动的最小角度（单位为弧度）。默认值等于 15 度。当 :ref:`motion_mode` 为 :ref:`MOTION_MODE_GROUNDED` 时，只有 :ref:`floor_block_on_wall` 为 ``true`` 才会影响运动。 +物体遇到墙面时允许发生滑动的最小角度（单位为弧度）。默认值等于 15 度。当 :ref:`motion_mode` 为 :ref:`MOTION_MODE_GROUNDED` 时，只有 :ref:`floor_block_on_wall` 为 ``true`` 才会影响运动。 .. rst-class:: classref-section-separator @@ -707,6 +711,7 @@ enum **PlatformOnLeave**: :ref:`🔗` 如果该物体发生了碰撞，则返回 ``true``\ ，否则返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_charfxtransform.rst b/classes/zh_CN/class_charfxtransform.rst index 5263319815..5ba1ee9ea0 100644 --- a/classes/zh_CN/class_charfxtransform.rst +++ b/classes/zh_CN/class_charfxtransform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CharFXTransform.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharFXTransform.xml. .. _class_CharFXTransform: @@ -311,6 +311,7 @@ CharFXTransform 如果为 ``true``\ ，将绘制字符。如果为 ``false``\ ，则隐藏字符。隐藏字符周围的字符将回流以占用隐藏字符的空间。如果不希望这样做，可以将它们的 :ref:`color` 设置为\ ``Color(1, 1, 1, 0)``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_checkbox.rst b/classes/zh_CN/class_checkbox.rst index 5274499934..f88f98181e 100644 --- a/classes/zh_CN/class_checkbox.rst +++ b/classes/zh_CN/class_checkbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CheckBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CheckBox.xml. .. _class_CheckBox: @@ -47,25 +47,29 @@ CheckBox .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_checked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_unchecked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`checkbox_checked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`checkbox_unchecked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_checked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_unchecked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -76,6 +80,30 @@ CheckBox 主题属性说明 ------------ +.. _class_CheckBox_theme_color_checkbox_checked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **checkbox_checked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +勾选图标的颜色，该 **CheckBox** 被按下时显示。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CheckBox_theme_color_checkbox_unchecked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **checkbox_unchecked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +未勾选图标的颜色，该 **CheckBox** 未被按下时显示。 + +.. rst-class:: classref-item-separator + +---- + .. _class_CheckBox_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty @@ -181,6 +209,7 @@ CheckBox 勾选图标，该 **CheckBox** 未勾选且被禁用时显示。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_checkbutton.rst b/classes/zh_CN/class_checkbutton.rst index e447136d4f..8dc9bb8b6e 100644 --- a/classes/zh_CN/class_checkbutton.rst +++ b/classes/zh_CN/class_checkbutton.rst @@ -1,9 +1,12 @@ :github_url: hide +.. meta:: + :keywords: switch, toggle + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CheckButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CheckButton.xml. .. _class_CheckButton: @@ -45,25 +48,29 @@ CheckButton .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`button_checked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`button_unchecked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -74,6 +81,30 @@ CheckButton 主题属性说明 ------------ +.. _class_CheckButton_theme_color_button_checked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **button_checked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +勾选图标的颜色，该 :ref:`CheckBox` 被按下时显示。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CheckButton_theme_color_button_unchecked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **button_unchecked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +未勾选图标的颜色，该 :ref:`CheckBox` 未被按下时显示。 + +.. rst-class:: classref-item-separator + +---- + .. _class_CheckButton_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty @@ -179,6 +210,7 @@ CheckButton 切换图标，该 **CheckButton** 未勾选时显示（用于从右至左布局）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_circleshape2d.rst b/classes/zh_CN/class_circleshape2d.rst index ab84a17a95..73fb5297b5 100644 --- a/classes/zh_CN/class_circleshape2d.rst +++ b/classes/zh_CN/class_circleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CircleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CircleShape2D.xml. .. _class_CircleShape2D: @@ -58,6 +58,7 @@ CircleShape2D 圆的半径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_classdb.rst b/classes/zh_CN/class_classdb.rst index 8846ebab8f..bf42c02ebe 100644 --- a/classes/zh_CN/class_classdb.rst +++ b/classes/zh_CN/class_classdb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ClassDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ClassDB.xml. .. _class_ClassDB: @@ -19,7 +19,9 @@ ClassDB 描述 ---- -提供对为每个可用类存储的元数据的访问。 +Provides access to metadata stored for every available engine class. + +\ **Note:** Script-defined classes with ``class_name`` are not part of **ClassDB**, so they will not return reflection data such as a method or property list. However, :ref:`GDExtension`-defined classes *are* part of **ClassDB**, so they will return reflection data. .. rst-class:: classref-reftable-group @@ -185,7 +187,7 @@ GDExtension 编辑器类型。 :ref:`bool` **class_exists**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` -返回指定的类 ``class`` 是否可用。 +返回 ``class`` 类是否可用。 .. rst-class:: classref-item-separator @@ -197,7 +199,7 @@ GDExtension 编辑器类型。 :ref:`APIType` **class_get_api_type**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` -返回 ``class`` 的 API 类型。见 :ref:`APIType`\ 。 +返回 ``class`` 类的 API 类型。 .. rst-class:: classref-item-separator @@ -439,7 +441,9 @@ GDExtension 编辑器类型。 :ref:`PackedStringArray` **get_class_list**\ (\ ) |const| :ref:`🔗` -返回所有可用类的名称。 +Returns the names of all engine classes available. + +\ **Note:** Script-defined classes with ``class_name`` are not included in this list. Use :ref:`ProjectSettings.get_global_class_list()` to get a list of script-defined classes instead. .. rst-class:: classref-item-separator @@ -451,7 +455,7 @@ GDExtension 编辑器类型。 :ref:`PackedStringArray` **get_inheriters_from_class**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` -返回所有直接或间接继承自 ``class`` 的类的名称。 +Returns the names of all engine classes that directly or indirectly inherit from ``class``. .. rst-class:: classref-item-separator @@ -514,6 +518,7 @@ GDExtension 编辑器类型。 返回 ``inherits`` 是否为 ``class`` 的祖先。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_codeedit.rst b/classes/zh_CN/class_codeedit.rst index 57371a964e..12ac320f50 100644 --- a/classes/zh_CN/class_codeedit.rst +++ b/classes/zh_CN/class_codeedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CodeEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CodeEdit.xml. .. _class_CodeEdit: @@ -310,7 +310,7 @@ CodeEdit 是一种专门用于编辑纯文本代码文件的 :ref:`TextEdit`\ ) :ref:`🔗` -在行中添加或移除断点时触发。如果该行通过退格键移动，则在旧行处触发一个移除的信号。 +为某一行添加或移除断点时触发。如果通过退格键移除该行，则会在原行处触发一次信号。 .. rst-class:: classref-item-separator @@ -827,7 +827,7 @@ enum **CodeCompletionLocation**: :ref:`🔗`\[:ref:`int`\]\ ) - :ref:`Array`\[:ref:`int`\] **get_line_length_guidelines**\ (\ ) -在提供的列上绘制垂直线。第一个条目被认为是主要的硬参考线，并且被绘制得更显眼。 +在提供的列上绘制垂直线。第一个条目被认为是主要的硬参考线，会绘制得更显眼。 .. rst-class:: classref-item-separator @@ -861,7 +861,7 @@ enum **CodeCompletionLocation**: :ref:`🔗`\ ) - :ref:`bool` **is_symbol_tooltip_on_hover_enabled**\ (\ ) -设置当悬停在单词上时，应发出 :ref:`symbol_hovered`\ 。 +如果为 ``true``\ ，则悬停在单词上时会发出 :ref:`symbol_hovered` 信号。 .. rst-class:: classref-section-separator @@ -2084,6 +2084,7 @@ enum **CodeCompletionLocation**: :ref:`🔗`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_codehighlighter.rst b/classes/zh_CN/class_codehighlighter.rst index aaf05e27f6..595e88a5f5 100644 --- a/classes/zh_CN/class_codehighlighter.rst +++ b/classes/zh_CN/class_codehighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CodeHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CodeHighlighter.xml. .. _class_CodeHighlighter: @@ -389,6 +389,7 @@ CodeHighlighter 移除成员关键字。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionobject2d.rst b/classes/zh_CN/class_collisionobject2d.rst index 48a69ff622..1b79009cb5 100644 --- a/classes/zh_CN/class_collisionobject2d.rst +++ b/classes/zh_CN/class_collisionobject2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionObject2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionObject2D.xml. .. _class_CollisionObject2D: @@ -300,7 +300,7 @@ enum **DisableMode**: :ref:`🔗` - |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) - :ref:`DisableMode` **get_disable_mode**\ (\ ) -定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。不同模式详见 :ref:`DisableMode`\ 。 +定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。 .. rst-class:: classref-item-separator @@ -675,6 +675,7 @@ enum **DisableMode**: :ref:`🔗` 设置给定形状所有者的 :ref:`Transform2D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionobject3d.rst b/classes/zh_CN/class_collisionobject3d.rst index 0689ae5c6d..1d8e623dcf 100644 --- a/classes/zh_CN/class_collisionobject3d.rst +++ b/classes/zh_CN/class_collisionobject3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionObject3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionObject3D.xml. .. _class_CollisionObject3D: @@ -266,7 +266,7 @@ enum **DisableMode**: :ref:`🔗` - |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) - :ref:`DisableMode` **get_disable_mode**\ (\ ) -定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。不同模式详见 :ref:`DisableMode`\ 。 +定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。 .. rst-class:: classref-item-separator @@ -586,6 +586,7 @@ enum **DisableMode**: :ref:`🔗` 设置给定形状所有者的 :ref:`Transform3D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionpolygon2d.rst b/classes/zh_CN/class_collisionpolygon2d.rst index 75a1878b25..909dc488b1 100644 --- a/classes/zh_CN/class_collisionpolygon2d.rst +++ b/classes/zh_CN/class_collisionpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionPolygon2D.xml. .. _class_CollisionPolygon2D: @@ -94,7 +94,7 @@ enum **BuildMode**: :ref:`🔗` - |void| **set_build_mode**\ (\ value\: :ref:`BuildMode`\ ) - :ref:`BuildMode` **get_build_mode**\ (\ ) -碰撞构建模式。使用 :ref:`BuildMode` 常量之一。 +碰撞构建模式。 .. rst-class:: classref-item-separator @@ -111,7 +111,7 @@ enum **BuildMode**: :ref:`🔗` - |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_disabled**\ (\ ) -如果为 ``true``\ ，则不会检测到碰撞。 +如果为 ``true``\ ，则不会检测到碰撞。该属性应使用 :ref:`Object.set_deferred()` 进行更改。 .. rst-class:: classref-item-separator @@ -171,6 +171,7 @@ enum **BuildMode**: :ref:`🔗` **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionpolygon3d.rst b/classes/zh_CN/class_collisionpolygon3d.rst index a1b4051f25..235e488216 100644 --- a/classes/zh_CN/class_collisionpolygon3d.rst +++ b/classes/zh_CN/class_collisionpolygon3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionPolygon3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionPolygon3D.xml. .. _class_CollisionPolygon3D: @@ -118,7 +118,7 @@ CollisionPolygon3D - |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_disabled**\ (\ ) -如果为 ``true``\ ，将不会产生碰撞。 +如果为 ``true``\ ，则不会产生碰撞。该属性应使用 :ref:`Object.set_deferred()` 进行更改。 .. rst-class:: classref-item-separator @@ -157,6 +157,7 @@ CollisionPolygon3D **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionshape2d.rst b/classes/zh_CN/class_collisionshape2d.rst index 5f17c13d42..f472b488a9 100644 --- a/classes/zh_CN/class_collisionshape2d.rst +++ b/classes/zh_CN/class_collisionshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionShape2D.xml. .. _class_CollisionShape2D: @@ -149,6 +149,7 @@ CollisionShape2D 该碰撞形状拥有的实际形状。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_collisionshape3d.rst b/classes/zh_CN/class_collisionshape3d.rst index e358c0ff1d..a4050cf16a 100644 --- a/classes/zh_CN/class_collisionshape3d.rst +++ b/classes/zh_CN/class_collisionshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CollisionShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionShape3D.xml. .. _class_CollisionShape3D: @@ -124,7 +124,7 @@ CollisionShape3D - |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_disabled**\ (\ ) -禁用的碰撞形状对世界没有任何影响。 +禁用的碰撞形状在世界中没有影响。这个属性应该用 :ref:`Object.set_deferred()` 改变。 .. rst-class:: classref-item-separator @@ -175,6 +175,7 @@ CollisionShape3D 这个方法什么也不做。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_color.rst b/classes/zh_CN/class_color.rst index d6d2bc0561..d56693f70f 100644 --- a/classes/zh_CN/class_color.rst +++ b/classes/zh_CN/class_color.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Color.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Color.xml. .. _class_Color: @@ -21,6 +21,8 @@ Color 创建颜色的方法有很多：可以使用 **Color** 的各种构造函数，\ :ref:`from_hsv()` 等静态方法，以及使用基于 `X11 颜色名称 `__\ 的标准化颜色集外加 :ref:`TRANSPARENT`\ 。GDScript 还提供了 :ref:`@GDScript.Color8()`\ ，使用的是 ``0`` 到 ``255`` 之间的整数，且不支持过亮的颜色。 +颜色数据可以使用不同的色彩空间和编码进行存储。\ :ref:`srgb_to_linear()` 和 :ref:`linear_to_srgb()` 方法可以在非线性 sRGB 编码和线性 RGB 编码之间进行转换。 + \ **注意：**\ 在布尔上下文中，等于 ``Color(0, 0, 0, 1)``\ （不透明的黑色）的 Color 将被评估为 ``false``\ 。否则，Color 将始终被评估为 ``true``\ 。 \ `Color 常量速查表 `__ @@ -213,7 +215,7 @@ Color .. rst-class:: classref-constant -**ALICE_BLUE** = ``Color(0.941176, 0.972549, 1, 1)`` :ref:`🔗` +**ALICE_BLUE** = ``Color(0.9411765, 0.972549, 1, 1)`` :ref:`🔗` 爱丽丝蓝。 @@ -221,7 +223,7 @@ Color .. rst-class:: classref-constant -**ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)`` :ref:`🔗` +**ANTIQUE_WHITE** = ``Color(0.98039216, 0.92156863, 0.84313726, 1)`` :ref:`🔗` 古董白。 @@ -237,7 +239,7 @@ Color .. rst-class:: classref-constant -**AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)`` :ref:`🔗` +**AQUAMARINE** = ``Color(0.49803922, 1, 0.83137256, 1)`` :ref:`🔗` 海蓝色。 @@ -245,7 +247,7 @@ Color .. rst-class:: classref-constant -**AZURE** = ``Color(0.941176, 1, 1, 1)`` :ref:`🔗` +**AZURE** = ``Color(0.9411765, 1, 1, 1)`` :ref:`🔗` 天蓝色。 @@ -253,7 +255,7 @@ Color .. rst-class:: classref-constant -**BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)`` :ref:`🔗` +**BEIGE** = ``Color(0.9607843, 0.9607843, 0.8627451, 1)`` :ref:`🔗` 米黄色。 @@ -261,7 +263,7 @@ Color .. rst-class:: classref-constant -**BISQUE** = ``Color(1, 0.894118, 0.768627, 1)`` :ref:`🔗` +**BISQUE** = ``Color(1, 0.89411765, 0.76862746, 1)`` :ref:`🔗` 橘黄色。 @@ -277,7 +279,7 @@ Color .. rst-class:: classref-constant -**BLANCHED_ALMOND** = ``Color(1, 0.921569, 0.803922, 1)`` :ref:`🔗` +**BLANCHED_ALMOND** = ``Color(1, 0.92156863, 0.8039216, 1)`` :ref:`🔗` 杏仁白色。 @@ -293,7 +295,7 @@ Color .. rst-class:: classref-constant -**BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)`` :ref:`🔗` +**BLUE_VIOLET** = ``Color(0.5411765, 0.16862746, 0.8862745, 1)`` :ref:`🔗` 蓝紫色的颜色。 @@ -301,7 +303,7 @@ Color .. rst-class:: classref-constant -**BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)`` :ref:`🔗` +**BROWN** = ``Color(0.64705884, 0.16470589, 0.16470589, 1)`` :ref:`🔗` 棕色。 @@ -309,7 +311,7 @@ Color .. rst-class:: classref-constant -**BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)`` :ref:`🔗` +**BURLYWOOD** = ``Color(0.87058824, 0.72156864, 0.5294118, 1)`` :ref:`🔗` 硬木色。 @@ -317,7 +319,7 @@ Color .. rst-class:: classref-constant -**CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)`` :ref:`🔗` +**CADET_BLUE** = ``Color(0.37254903, 0.61960787, 0.627451, 1)`` :ref:`🔗` 军服蓝。 @@ -325,7 +327,7 @@ Color .. rst-class:: classref-constant -**CHARTREUSE** = ``Color(0.498039, 1, 0, 1)`` :ref:`🔗` +**CHARTREUSE** = ``Color(0.49803922, 1, 0, 1)`` :ref:`🔗` 黄褐色。 @@ -333,7 +335,7 @@ Color .. rst-class:: classref-constant -**CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)`` :ref:`🔗` +**CHOCOLATE** = ``Color(0.8235294, 0.4117647, 0.11764706, 1)`` :ref:`🔗` 巧克力色。 @@ -341,7 +343,7 @@ Color .. rst-class:: classref-constant -**CORAL** = ``Color(1, 0.498039, 0.313726, 1)`` :ref:`🔗` +**CORAL** = ``Color(1, 0.49803922, 0.3137255, 1)`` :ref:`🔗` 珊瑚色。 @@ -349,7 +351,7 @@ Color .. rst-class:: classref-constant -**CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)`` :ref:`🔗` +**CORNFLOWER_BLUE** = ``Color(0.39215687, 0.58431375, 0.92941177, 1)`` :ref:`🔗` 矢车菊蓝色。 @@ -357,7 +359,7 @@ Color .. rst-class:: classref-constant -**CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)`` :ref:`🔗` +**CORNSILK** = ``Color(1, 0.972549, 0.8627451, 1)`` :ref:`🔗` 玉米须色。 @@ -365,7 +367,7 @@ Color .. rst-class:: classref-constant -**CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)`` :ref:`🔗` +**CRIMSON** = ``Color(0.8627451, 0.078431375, 0.23529412, 1)`` :ref:`🔗` 绯红的颜色。 @@ -381,7 +383,7 @@ Color .. rst-class:: classref-constant -**DARK_BLUE** = ``Color(0, 0, 0.545098, 1)`` :ref:`🔗` +**DARK_BLUE** = ``Color(0, 0, 0.54509807, 1)`` :ref:`🔗` 深蓝色。 @@ -389,7 +391,7 @@ Color .. rst-class:: classref-constant -**DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)`` :ref:`🔗` +**DARK_CYAN** = ``Color(0, 0.54509807, 0.54509807, 1)`` :ref:`🔗` 深青色。 @@ -397,7 +399,7 @@ Color .. rst-class:: classref-constant -**DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)`` :ref:`🔗` +**DARK_GOLDENROD** = ``Color(0.72156864, 0.5254902, 0.043137256, 1)`` :ref:`🔗` 深色菊科植物的颜色。 @@ -405,7 +407,7 @@ Color .. rst-class:: classref-constant -**DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)`` :ref:`🔗` +**DARK_GRAY** = ``Color(0.6627451, 0.6627451, 0.6627451, 1)`` :ref:`🔗` 深灰色。 @@ -413,7 +415,7 @@ Color .. rst-class:: classref-constant -**DARK_GREEN** = ``Color(0, 0.392157, 0, 1)`` :ref:`🔗` +**DARK_GREEN** = ``Color(0, 0.39215687, 0, 1)`` :ref:`🔗` 深绿色。 @@ -421,7 +423,7 @@ Color .. rst-class:: classref-constant -**DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)`` :ref:`🔗` +**DARK_KHAKI** = ``Color(0.7411765, 0.7176471, 0.41960785, 1)`` :ref:`🔗` 深卡其色。 @@ -429,7 +431,7 @@ Color .. rst-class:: classref-constant -**DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)`` :ref:`🔗` +**DARK_MAGENTA** = ``Color(0.54509807, 0, 0.54509807, 1)`` :ref:`🔗` 深洋红色。 @@ -437,7 +439,7 @@ Color .. rst-class:: classref-constant -**DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)`` :ref:`🔗` +**DARK_OLIVE_GREEN** = ``Color(0.33333334, 0.41960785, 0.18431373, 1)`` :ref:`🔗` 深橄榄绿色。 @@ -445,7 +447,7 @@ Color .. rst-class:: classref-constant -**DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)`` :ref:`🔗` +**DARK_ORANGE** = ``Color(1, 0.54901963, 0, 1)`` :ref:`🔗` 深橙色。 @@ -453,7 +455,7 @@ Color .. rst-class:: classref-constant -**DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)`` :ref:`🔗` +**DARK_ORCHID** = ``Color(0.6, 0.19607843, 0.8, 1)`` :ref:`🔗` 深色的兰花色。 @@ -461,7 +463,7 @@ Color .. rst-class:: classref-constant -**DARK_RED** = ``Color(0.545098, 0, 0, 1)`` :ref:`🔗` +**DARK_RED** = ``Color(0.54509807, 0, 0, 1)`` :ref:`🔗` 深红色。 @@ -469,7 +471,7 @@ Color .. rst-class:: classref-constant -**DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)`` :ref:`🔗` +**DARK_SALMON** = ``Color(0.9137255, 0.5882353, 0.47843137, 1)`` :ref:`🔗` 深鲑鱼色。 @@ -477,7 +479,7 @@ Color .. rst-class:: classref-constant -**DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)`` :ref:`🔗` +**DARK_SEA_GREEN** = ``Color(0.56078434, 0.7372549, 0.56078434, 1)`` :ref:`🔗` 深海绿色。 @@ -485,7 +487,7 @@ Color .. rst-class:: classref-constant -**DARK_SLATE_BLUE** = ``Color(0.282353, 0.239216, 0.545098, 1)`` :ref:`🔗` +**DARK_SLATE_BLUE** = ``Color(0.28235295, 0.23921569, 0.54509807, 1)`` :ref:`🔗` 深板蓝的颜色。 @@ -493,7 +495,7 @@ Color .. rst-class:: classref-constant -**DARK_SLATE_GRAY** = ``Color(0.184314, 0.309804, 0.309804, 1)`` :ref:`🔗` +**DARK_SLATE_GRAY** = ``Color(0.18431373, 0.30980393, 0.30980393, 1)`` :ref:`🔗` 暗石板灰色。 @@ -501,7 +503,7 @@ Color .. rst-class:: classref-constant -**DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)`` :ref:`🔗` +**DARK_TURQUOISE** = ``Color(0, 0.80784315, 0.81960785, 1)`` :ref:`🔗` 深绿松石色。 @@ -509,7 +511,7 @@ Color .. rst-class:: classref-constant -**DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)`` :ref:`🔗` +**DARK_VIOLET** = ``Color(0.5803922, 0, 0.827451, 1)`` :ref:`🔗` 深紫罗兰色。 @@ -517,7 +519,7 @@ Color .. rst-class:: classref-constant -**DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)`` :ref:`🔗` +**DEEP_PINK** = ``Color(1, 0.078431375, 0.5764706, 1)`` :ref:`🔗` 深粉色。 @@ -525,7 +527,7 @@ Color .. rst-class:: classref-constant -**DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)`` :ref:`🔗` +**DEEP_SKY_BLUE** = ``Color(0, 0.7490196, 1, 1)`` :ref:`🔗` 深邃的天蓝色。 @@ -533,7 +535,7 @@ Color .. rst-class:: classref-constant -**DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)`` :ref:`🔗` +**DIM_GRAY** = ``Color(0.4117647, 0.4117647, 0.4117647, 1)`` :ref:`🔗` 暗灰色。 @@ -541,7 +543,7 @@ Color .. rst-class:: classref-constant -**DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)`` :ref:`🔗` +**DODGER_BLUE** = ``Color(0.11764706, 0.5647059, 1, 1)`` :ref:`🔗` 道奇蓝色。 @@ -549,7 +551,7 @@ Color .. rst-class:: classref-constant -**FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)`` :ref:`🔗` +**FIREBRICK** = ``Color(0.69803923, 0.13333334, 0.13333334, 1)`` :ref:`🔗` 耐火砖红色。 @@ -557,7 +559,7 @@ Color .. rst-class:: classref-constant -**FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)`` :ref:`🔗` +**FLORAL_WHITE** = ``Color(1, 0.98039216, 0.9411765, 1)`` :ref:`🔗` 花白色。 @@ -565,7 +567,7 @@ Color .. rst-class:: classref-constant -**FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)`` :ref:`🔗` +**FOREST_GREEN** = ``Color(0.13333334, 0.54509807, 0.13333334, 1)`` :ref:`🔗` 森林绿色。 @@ -581,7 +583,7 @@ Color .. rst-class:: classref-constant -**GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)`` :ref:`🔗` +**GAINSBORO** = ``Color(0.8627451, 0.8627451, 0.8627451, 1)`` :ref:`🔗` 庚斯伯勒灰色。 @@ -597,7 +599,7 @@ Color .. rst-class:: classref-constant -**GOLD** = ``Color(1, 0.843137, 0, 1)`` :ref:`🔗` +**GOLD** = ``Color(1, 0.84313726, 0, 1)`` :ref:`🔗` 金色。 @@ -605,7 +607,7 @@ Color .. rst-class:: classref-constant -**GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)`` :ref:`🔗` +**GOLDENROD** = ``Color(0.85490197, 0.64705884, 0.1254902, 1)`` :ref:`🔗` 金菊色。 @@ -613,7 +615,7 @@ Color .. rst-class:: classref-constant -**GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)`` :ref:`🔗` +**GRAY** = ``Color(0.74509805, 0.74509805, 0.74509805, 1)`` :ref:`🔗` 灰色。 @@ -629,7 +631,7 @@ Color .. rst-class:: classref-constant -**GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)`` :ref:`🔗` +**GREEN_YELLOW** = ``Color(0.6784314, 1, 0.18431373, 1)`` :ref:`🔗` 绿黄色。 @@ -637,7 +639,7 @@ Color .. rst-class:: classref-constant -**HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)`` :ref:`🔗` +**HONEYDEW** = ``Color(0.9411765, 1, 0.9411765, 1)`` :ref:`🔗` 蜜露色。 @@ -645,7 +647,7 @@ Color .. rst-class:: classref-constant -**HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)`` :ref:`🔗` +**HOT_PINK** = ``Color(1, 0.4117647, 0.7058824, 1)`` :ref:`🔗` 亮粉色。 @@ -653,7 +655,7 @@ Color .. rst-class:: classref-constant -**INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)`` :ref:`🔗` +**INDIAN_RED** = ``Color(0.8039216, 0.36078432, 0.36078432, 1)`` :ref:`🔗` 印度红色。 @@ -661,7 +663,7 @@ Color .. rst-class:: classref-constant -**INDIGO** = ``Color(0.294118, 0, 0.509804, 1)`` :ref:`🔗` +**INDIGO** = ``Color(0.29411766, 0, 0.50980395, 1)`` :ref:`🔗` 靛青色。 @@ -669,7 +671,7 @@ Color .. rst-class:: classref-constant -**IVORY** = ``Color(1, 1, 0.941176, 1)`` :ref:`🔗` +**IVORY** = ``Color(1, 1, 0.9411765, 1)`` :ref:`🔗` 象牙色。 @@ -677,7 +679,7 @@ Color .. rst-class:: classref-constant -**KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)`` :ref:`🔗` +**KHAKI** = ``Color(0.9411765, 0.9019608, 0.54901963, 1)`` :ref:`🔗` 卡其色。 @@ -685,7 +687,7 @@ Color .. rst-class:: classref-constant -**LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)`` :ref:`🔗` +**LAVENDER** = ``Color(0.9019608, 0.9019608, 0.98039216, 1)`` :ref:`🔗` 薰衣草色。 @@ -693,7 +695,7 @@ Color .. rst-class:: classref-constant -**LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)`` :ref:`🔗` +**LAVENDER_BLUSH** = ``Color(1, 0.9411765, 0.9607843, 1)`` :ref:`🔗` 薰衣草紫红色。 @@ -701,7 +703,7 @@ Color .. rst-class:: classref-constant -**LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)`` :ref:`🔗` +**LAWN_GREEN** = ``Color(0.4862745, 0.9882353, 0, 1)`` :ref:`🔗` 草坪绿色。 @@ -709,7 +711,7 @@ Color .. rst-class:: classref-constant -**LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)`` :ref:`🔗` +**LEMON_CHIFFON** = ``Color(1, 0.98039216, 0.8039216, 1)`` :ref:`🔗` 柠檬雪纺色。 @@ -717,7 +719,7 @@ Color .. rst-class:: classref-constant -**LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)`` :ref:`🔗` +**LIGHT_BLUE** = ``Color(0.6784314, 0.84705883, 0.9019608, 1)`` :ref:`🔗` 浅蓝色。 @@ -725,7 +727,7 @@ Color .. rst-class:: classref-constant -**LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)`` :ref:`🔗` +**LIGHT_CORAL** = ``Color(0.9411765, 0.5019608, 0.5019608, 1)`` :ref:`🔗` 浅珊瑚色。 @@ -733,7 +735,7 @@ Color .. rst-class:: classref-constant -**LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)`` :ref:`🔗` +**LIGHT_CYAN** = ``Color(0.8784314, 1, 1, 1)`` :ref:`🔗` 淡青色。 @@ -741,7 +743,7 @@ Color .. rst-class:: classref-constant -**LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)`` :ref:`🔗` +**LIGHT_GOLDENROD** = ``Color(0.98039216, 0.98039216, 0.8235294, 1)`` :ref:`🔗` 亮金菊黄色。 @@ -757,7 +759,7 @@ Color .. rst-class:: classref-constant -**LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)`` :ref:`🔗` +**LIGHT_GREEN** = ``Color(0.5647059, 0.93333334, 0.5647059, 1)`` :ref:`🔗` 浅绿色。 @@ -765,7 +767,7 @@ Color .. rst-class:: classref-constant -**LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)`` :ref:`🔗` +**LIGHT_PINK** = ``Color(1, 0.7137255, 0.75686276, 1)`` :ref:`🔗` 浅粉色。 @@ -773,7 +775,7 @@ Color .. rst-class:: classref-constant -**LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)`` :ref:`🔗` +**LIGHT_SALMON** = ``Color(1, 0.627451, 0.47843137, 1)`` :ref:`🔗` 浅鲑鱼色。 @@ -781,7 +783,7 @@ Color .. rst-class:: classref-constant -**LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)`` :ref:`🔗` +**LIGHT_SEA_GREEN** = ``Color(0.1254902, 0.69803923, 0.6666667, 1)`` :ref:`🔗` 浅海绿色。 @@ -789,7 +791,7 @@ Color .. rst-class:: classref-constant -**LIGHT_SKY_BLUE** = ``Color(0.529412, 0.807843, 0.980392, 1)`` :ref:`🔗` +**LIGHT_SKY_BLUE** = ``Color(0.5294118, 0.80784315, 0.98039216, 1)`` :ref:`🔗` 浅天蓝色。 @@ -797,7 +799,7 @@ Color .. rst-class:: classref-constant -**LIGHT_SLATE_GRAY** = ``Color(0.466667, 0.533333, 0.6, 1)`` :ref:`🔗` +**LIGHT_SLATE_GRAY** = ``Color(0.46666667, 0.53333336, 0.6, 1)`` :ref:`🔗` 浅板岩灰色。 @@ -805,7 +807,7 @@ Color .. rst-class:: classref-constant -**LIGHT_STEEL_BLUE** = ``Color(0.690196, 0.768627, 0.870588, 1)`` :ref:`🔗` +**LIGHT_STEEL_BLUE** = ``Color(0.6901961, 0.76862746, 0.87058824, 1)`` :ref:`🔗` 浅钢蓝色。 @@ -813,7 +815,7 @@ Color .. rst-class:: classref-constant -**LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)`` :ref:`🔗` +**LIGHT_YELLOW** = ``Color(1, 1, 0.8784314, 1)`` :ref:`🔗` 浅黄色。 @@ -829,7 +831,7 @@ Color .. rst-class:: classref-constant -**LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)`` :ref:`🔗` +**LIME_GREEN** = ``Color(0.19607843, 0.8039216, 0.19607843, 1)`` :ref:`🔗` 石灰绿色。 @@ -837,7 +839,7 @@ Color .. rst-class:: classref-constant -**LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)`` :ref:`🔗` +**LINEN** = ``Color(0.98039216, 0.9411765, 0.9019608, 1)`` :ref:`🔗` 亚麻色。 @@ -853,7 +855,7 @@ Color .. rst-class:: classref-constant -**MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)`` :ref:`🔗` +**MAROON** = ``Color(0.6901961, 0.1882353, 0.3764706, 1)`` :ref:`🔗` 栗色。 @@ -861,7 +863,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)`` :ref:`🔗` +**MEDIUM_AQUAMARINE** = ``Color(0.4, 0.8039216, 0.6666667, 1)`` :ref:`🔗` 中等海蓝宝石色。 @@ -869,7 +871,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)`` :ref:`🔗` +**MEDIUM_BLUE** = ``Color(0, 0, 0.8039216, 1)`` :ref:`🔗` 中蓝色。 @@ -877,7 +879,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)`` :ref:`🔗` +**MEDIUM_ORCHID** = ``Color(0.7294118, 0.33333334, 0.827451, 1)`` :ref:`🔗` 中等兰色。 @@ -885,7 +887,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)`` :ref:`🔗` +**MEDIUM_PURPLE** = ``Color(0.5764706, 0.4392157, 0.85882354, 1)`` :ref:`🔗` 中等紫色。 @@ -893,7 +895,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)`` :ref:`🔗` +**MEDIUM_SEA_GREEN** = ``Color(0.23529412, 0.7019608, 0.44313726, 1)`` :ref:`🔗` 中海绿色。 @@ -901,7 +903,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_SLATE_BLUE** = ``Color(0.482353, 0.407843, 0.933333, 1)`` :ref:`🔗` +**MEDIUM_SLATE_BLUE** = ``Color(0.48235294, 0.40784314, 0.93333334, 1)`` :ref:`🔗` 中等板岩蓝色。 @@ -909,7 +911,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)`` :ref:`🔗` +**MEDIUM_SPRING_GREEN** = ``Color(0, 0.98039216, 0.6039216, 1)`` :ref:`🔗` 中等春天绿色。 @@ -917,7 +919,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)`` :ref:`🔗` +**MEDIUM_TURQUOISE** = ``Color(0.28235295, 0.81960785, 0.8, 1)`` :ref:`🔗` 中等绿松石色。 @@ -925,7 +927,7 @@ Color .. rst-class:: classref-constant -**MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)`` :ref:`🔗` +**MEDIUM_VIOLET_RED** = ``Color(0.78039217, 0.08235294, 0.52156866, 1)`` :ref:`🔗` 中等紫红色。 @@ -933,7 +935,7 @@ Color .. rst-class:: classref-constant -**MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)`` :ref:`🔗` +**MIDNIGHT_BLUE** = ``Color(0.09803922, 0.09803922, 0.4392157, 1)`` :ref:`🔗` 午夜蓝色。 @@ -941,7 +943,7 @@ Color .. rst-class:: classref-constant -**MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)`` :ref:`🔗` +**MINT_CREAM** = ``Color(0.9607843, 1, 0.98039216, 1)`` :ref:`🔗` 薄荷奶油色。 @@ -949,7 +951,7 @@ Color .. rst-class:: classref-constant -**MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)`` :ref:`🔗` +**MISTY_ROSE** = ``Color(1, 0.89411765, 0.88235295, 1)`` :ref:`🔗` 朦胧的玫瑰色。 @@ -957,7 +959,7 @@ Color .. rst-class:: classref-constant -**MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)`` :ref:`🔗` +**MOCCASIN** = ``Color(1, 0.89411765, 0.70980394, 1)`` :ref:`🔗` 鹿皮鞋颜色。 @@ -965,7 +967,7 @@ Color .. rst-class:: classref-constant -**NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)`` :ref:`🔗` +**NAVAJO_WHITE** = ``Color(1, 0.87058824, 0.6784314, 1)`` :ref:`🔗` 纳瓦白。 @@ -973,7 +975,7 @@ Color .. rst-class:: classref-constant -**NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)`` :ref:`🔗` +**NAVY_BLUE** = ``Color(0, 0, 0.5019608, 1)`` :ref:`🔗` 藏青色。 @@ -981,7 +983,7 @@ Color .. rst-class:: classref-constant -**OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)`` :ref:`🔗` +**OLD_LACE** = ``Color(0.99215686, 0.9607843, 0.9019608, 1)`` :ref:`🔗` 旧蕾丝色。 @@ -989,7 +991,7 @@ Color .. rst-class:: classref-constant -**OLIVE** = ``Color(0.501961, 0.501961, 0, 1)`` :ref:`🔗` +**OLIVE** = ``Color(0.5019608, 0.5019608, 0, 1)`` :ref:`🔗` 橄榄色。 @@ -997,7 +999,7 @@ Color .. rst-class:: classref-constant -**OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)`` :ref:`🔗` +**OLIVE_DRAB** = ``Color(0.41960785, 0.5568628, 0.13725491, 1)`` :ref:`🔗` 暗淡橄榄色。 @@ -1005,7 +1007,7 @@ Color .. rst-class:: classref-constant -**ORANGE** = ``Color(1, 0.647059, 0, 1)`` :ref:`🔗` +**ORANGE** = ``Color(1, 0.64705884, 0, 1)`` :ref:`🔗` 橙色。 @@ -1013,7 +1015,7 @@ Color .. rst-class:: classref-constant -**ORANGE_RED** = ``Color(1, 0.270588, 0, 1)`` :ref:`🔗` +**ORANGE_RED** = ``Color(1, 0.27058825, 0, 1)`` :ref:`🔗` 橘红色。 @@ -1021,7 +1023,7 @@ Color .. rst-class:: classref-constant -**ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)`` :ref:`🔗` +**ORCHID** = ``Color(0.85490197, 0.4392157, 0.8392157, 1)`` :ref:`🔗` 兰花色。 @@ -1029,7 +1031,7 @@ Color .. rst-class:: classref-constant -**PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)`` :ref:`🔗` +**PALE_GOLDENROD** = ``Color(0.93333334, 0.9098039, 0.6666667, 1)`` :ref:`🔗` 淡金色。 @@ -1037,7 +1039,7 @@ Color .. rst-class:: classref-constant -**PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)`` :ref:`🔗` +**PALE_GREEN** = ``Color(0.59607846, 0.9843137, 0.59607846, 1)`` :ref:`🔗` 淡绿色。 @@ -1045,7 +1047,7 @@ Color .. rst-class:: classref-constant -**PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)`` :ref:`🔗` +**PALE_TURQUOISE** = ``Color(0.6862745, 0.93333334, 0.93333334, 1)`` :ref:`🔗` 淡绿松石色。 @@ -1053,7 +1055,7 @@ Color .. rst-class:: classref-constant -**PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)`` :ref:`🔗` +**PALE_VIOLET_RED** = ``Color(0.85882354, 0.4392157, 0.5764706, 1)`` :ref:`🔗` 淡紫红色。 @@ -1061,7 +1063,7 @@ Color .. rst-class:: classref-constant -**PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)`` :ref:`🔗` +**PAPAYA_WHIP** = ``Color(1, 0.9372549, 0.8352941, 1)`` :ref:`🔗` 木瓜鞭色。 @@ -1069,7 +1071,7 @@ Color .. rst-class:: classref-constant -**PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)`` :ref:`🔗` +**PEACH_PUFF** = ``Color(1, 0.85490197, 0.7254902, 1)`` :ref:`🔗` 桃花粉。 @@ -1077,7 +1079,7 @@ Color .. rst-class:: classref-constant -**PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)`` :ref:`🔗` +**PERU** = ``Color(0.8039216, 0.52156866, 0.24705882, 1)`` :ref:`🔗` 秘鲁色。 @@ -1085,7 +1087,7 @@ Color .. rst-class:: classref-constant -**PINK** = ``Color(1, 0.752941, 0.796078, 1)`` :ref:`🔗` +**PINK** = ``Color(1, 0.7529412, 0.79607844, 1)`` :ref:`🔗` 粉红色。 @@ -1093,7 +1095,7 @@ Color .. rst-class:: classref-constant -**PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)`` :ref:`🔗` +**PLUM** = ``Color(0.8666667, 0.627451, 0.8666667, 1)`` :ref:`🔗` 梅花色。 @@ -1101,7 +1103,7 @@ Color .. rst-class:: classref-constant -**POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)`` :ref:`🔗` +**POWDER_BLUE** = ``Color(0.6901961, 0.8784314, 0.9019608, 1)`` :ref:`🔗` 浅蓝色。 @@ -1109,7 +1111,7 @@ Color .. rst-class:: classref-constant -**PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)`` :ref:`🔗` +**PURPLE** = ``Color(0.627451, 0.1254902, 0.9411765, 1)`` :ref:`🔗` 紫色。 @@ -1133,7 +1135,7 @@ Color .. rst-class:: classref-constant -**ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)`` :ref:`🔗` +**ROSY_BROWN** = ``Color(0.7372549, 0.56078434, 0.56078434, 1)`` :ref:`🔗` 玫瑰棕。 @@ -1141,7 +1143,7 @@ Color .. rst-class:: classref-constant -**ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)`` :ref:`🔗` +**ROYAL_BLUE** = ``Color(0.25490198, 0.4117647, 0.88235295, 1)`` :ref:`🔗` 宝蓝色。 @@ -1149,7 +1151,7 @@ Color .. rst-class:: classref-constant -**SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)`` :ref:`🔗` +**SADDLE_BROWN** = ``Color(0.54509807, 0.27058825, 0.07450981, 1)`` :ref:`🔗` 鞍棕色。 @@ -1157,7 +1159,7 @@ Color .. rst-class:: classref-constant -**SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)`` :ref:`🔗` +**SALMON** = ``Color(0.98039216, 0.5019608, 0.44705883, 1)`` :ref:`🔗` 鲑鱼色。 @@ -1165,7 +1167,7 @@ Color .. rst-class:: classref-constant -**SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)`` :ref:`🔗` +**SANDY_BROWN** = ``Color(0.95686275, 0.6431373, 0.3764706, 1)`` :ref:`🔗` 沙褐色。 @@ -1173,7 +1175,7 @@ Color .. rst-class:: classref-constant -**SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)`` :ref:`🔗` +**SEA_GREEN** = ``Color(0.18039216, 0.54509807, 0.34117648, 1)`` :ref:`🔗` 海绿色。 @@ -1181,7 +1183,7 @@ Color .. rst-class:: classref-constant -**SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)`` :ref:`🔗` +**SEASHELL** = ``Color(1, 0.9607843, 0.93333334, 1)`` :ref:`🔗` 贝壳色。 @@ -1189,7 +1191,7 @@ Color .. rst-class:: classref-constant -**SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)`` :ref:`🔗` +**SIENNA** = ``Color(0.627451, 0.32156864, 0.1764706, 1)`` :ref:`🔗` 西恩娜色。 @@ -1197,7 +1199,7 @@ Color .. rst-class:: classref-constant -**SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)`` :ref:`🔗` +**SILVER** = ``Color(0.7529412, 0.7529412, 0.7529412, 1)`` :ref:`🔗` 银色。 @@ -1205,7 +1207,7 @@ Color .. rst-class:: classref-constant -**SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)`` :ref:`🔗` +**SKY_BLUE** = ``Color(0.5294118, 0.80784315, 0.92156863, 1)`` :ref:`🔗` 天蓝色。 @@ -1213,7 +1215,7 @@ Color .. rst-class:: classref-constant -**SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)`` :ref:`🔗` +**SLATE_BLUE** = ``Color(0.41568628, 0.3529412, 0.8039216, 1)`` :ref:`🔗` 石板蓝色。 @@ -1221,7 +1223,7 @@ Color .. rst-class:: classref-constant -**SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)`` :ref:`🔗` +**SLATE_GRAY** = ``Color(0.4392157, 0.5019608, 0.5647059, 1)`` :ref:`🔗` 石板灰。 @@ -1229,7 +1231,7 @@ Color .. rst-class:: classref-constant -**SNOW** = ``Color(1, 0.980392, 0.980392, 1)`` :ref:`🔗` +**SNOW** = ``Color(1, 0.98039216, 0.98039216, 1)`` :ref:`🔗` 雪白。 @@ -1237,7 +1239,7 @@ Color .. rst-class:: classref-constant -**SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)`` :ref:`🔗` +**SPRING_GREEN** = ``Color(0, 1, 0.49803922, 1)`` :ref:`🔗` 春绿。 @@ -1245,7 +1247,7 @@ Color .. rst-class:: classref-constant -**STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)`` :ref:`🔗` +**STEEL_BLUE** = ``Color(0.27450982, 0.50980395, 0.7058824, 1)`` :ref:`🔗` 钢蓝色。 @@ -1253,7 +1255,7 @@ Color .. rst-class:: classref-constant -**TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)`` :ref:`🔗` +**TAN** = ``Color(0.8235294, 0.7058824, 0.54901963, 1)`` :ref:`🔗` 棕褐色。 @@ -1261,7 +1263,7 @@ Color .. rst-class:: classref-constant -**TEAL** = ``Color(0, 0.501961, 0.501961, 1)`` :ref:`🔗` +**TEAL** = ``Color(0, 0.5019608, 0.5019608, 1)`` :ref:`🔗` 青色。 @@ -1269,7 +1271,7 @@ Color .. rst-class:: classref-constant -**THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)`` :ref:`🔗` +**THISTLE** = ``Color(0.84705883, 0.7490196, 0.84705883, 1)`` :ref:`🔗` 蓟色。 @@ -1277,7 +1279,7 @@ Color .. rst-class:: classref-constant -**TOMATO** = ``Color(1, 0.388235, 0.278431, 1)`` :ref:`🔗` +**TOMATO** = ``Color(1, 0.3882353, 0.2784314, 1)`` :ref:`🔗` 番茄色。 @@ -1293,7 +1295,7 @@ Color .. rst-class:: classref-constant -**TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)`` :ref:`🔗` +**TURQUOISE** = ``Color(0.2509804, 0.8784314, 0.8156863, 1)`` :ref:`🔗` 松石绿。 @@ -1301,7 +1303,7 @@ Color .. rst-class:: classref-constant -**VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)`` :ref:`🔗` +**VIOLET** = ``Color(0.93333334, 0.50980395, 0.93333334, 1)`` :ref:`🔗` 紫罗兰色。 @@ -1309,7 +1311,7 @@ Color .. rst-class:: classref-constant -**WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)`` :ref:`🔗` +**WEB_GRAY** = ``Color(0.5019608, 0.5019608, 0.5019608, 1)`` :ref:`🔗` 网格灰。 @@ -1317,7 +1319,7 @@ Color .. rst-class:: classref-constant -**WEB_GREEN** = ``Color(0, 0.501961, 0, 1)`` :ref:`🔗` +**WEB_GREEN** = ``Color(0, 0.5019608, 0, 1)`` :ref:`🔗` 网络绿。 @@ -1325,7 +1327,7 @@ Color .. rst-class:: classref-constant -**WEB_MAROON** = ``Color(0.501961, 0, 0, 1)`` :ref:`🔗` +**WEB_MAROON** = ``Color(0.5019608, 0, 0, 1)`` :ref:`🔗` 网络栗。 @@ -1333,7 +1335,7 @@ Color .. rst-class:: classref-constant -**WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)`` :ref:`🔗` +**WEB_PURPLE** = ``Color(0.5019608, 0, 0.5019608, 1)`` :ref:`🔗` 网络紫。 @@ -1341,7 +1343,7 @@ Color .. rst-class:: classref-constant -**WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)`` :ref:`🔗` +**WHEAT** = ``Color(0.9607843, 0.87058824, 0.7019608, 1)`` :ref:`🔗` 小麦色。 @@ -1357,7 +1359,7 @@ Color .. rst-class:: classref-constant -**WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)`` :ref:`🔗` +**WHITE_SMOKE** = ``Color(0.9607843, 0.9607843, 0.9607843, 1)`` :ref:`🔗` 白烟色。 @@ -1373,7 +1375,7 @@ Color .. rst-class:: classref-constant -**YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)`` :ref:`🔗` +**YELLOW_GREEN** = ``Color(0.6039216, 0.8039216, 0.19607843, 1)`` :ref:`🔗` 黄绿色。 @@ -1392,7 +1394,9 @@ Color :ref:`float` **a** = ``1.0`` :ref:`🔗` -颜色的 Alpha 分量，一般在 0 到 1 的范围内。0 表示该颜色完全透明。1 表示该颜色完全不透明。 +颜色的 Alpha 分量，通常在 0 到 1 的范围内。取值为 0 表示颜色完全透明。取值为 1 表示颜色完全不透明。 + +\ **注意：**\ Alpha 通道始终按照线性编码存储，与其他颜色通道的色彩空间无关。\ :ref:`linear_to_srgb()` 和 :ref:`srgb_to_linear()` 等方法不影响 Alpha 通道。 .. rst-class:: classref-item-separator @@ -1950,7 +1954,7 @@ Color Color.html_is_valid("#55AAFF20") # 返回 true Color.html_is_valid("55AAFF") # 返回 true Color.html_is_valid("#F2C") # 返回 true - + Color.html_is_valid("#AABBC") # 返回 false Color.html_is_valid("#55aaFF5") # 返回 false @@ -1960,7 +1964,7 @@ Color Color.HtmlIsValid("#55AAFF20"); // 返回 true Color.HtmlIsValid("55AAFF"); // 返回 true Color.HtmlIsValid("#F2C"); // 返回 true - + Color.HtmlIsValid("#AABBC"); // 返回 false Color.HtmlIsValid("#55aaFF5"); // 返回 false @@ -2026,7 +2030,7 @@ Color var red = Color(1.0, 0.0, 0.0) var aqua = Color(0.0, 1.0, 0.8) - + red.lerp(aqua, 0.2) # 返回 Color(0.8, 0.2, 0.16) red.lerp(aqua, 0.5) # 返回 Color(0.5, 0.5, 0.4) red.lerp(aqua, 1.0) # 返回 Color(0.0, 1.0, 0.8) @@ -2035,7 +2039,7 @@ Color var red = new Color(1.0f, 0.0f, 0.0f); var aqua = new Color(0.0f, 1.0f, 0.8f); - + red.Lerp(aqua, 0.2f); // 返回 Color(0.8f, 0.2f, 0.16f) red.Lerp(aqua, 0.5f); // 返回 Color(0.5f, 0.5f, 0.4f) red.Lerp(aqua, 1.0f); // 返回 Color(0.0f, 1.0f, 0.8f) @@ -2081,6 +2085,8 @@ Color 返回转换到 `sRGB `__ 色彩空间的颜色。该方法假定原始颜色位于线性色彩空间中。另见执行相反操作的 :ref:`srgb_to_linear()`\ 。 +\ **注意：**\ 颜色的 Alpha 通道 :ref:`a` 不受影响。Alpha 通道始终使用线性编码，与其他颜色通道所使用的色彩空间无关。 + .. rst-class:: classref-item-separator ---- @@ -2093,6 +2099,8 @@ Color 返回转换到线性色彩空间的颜色。该方法假定原始颜色已经在 sRGB 色彩空间中。另请参见执行相反操作的 :ref:`linear_to_srgb()`\ 。 +\ **注意：**\ 颜色的 Alpha 通道 :ref:`a` 不受影响。Alpha 通道始终使用线性编码，与其他颜色通道所使用的色彩空间无关。 + .. rst-class:: classref-item-separator ---- @@ -2452,6 +2460,7 @@ Color 反转给定的颜色。这相当于 ``Color.WHITE - c`` 或 ``Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)``\ 。与 :ref:`inverted()` 不同，\ :ref:`a` 分量也将被反转。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_colorpalette.rst b/classes/zh_CN/class_colorpalette.rst index c7fc19e95e..3419535608 100644 --- a/classes/zh_CN/class_colorpalette.rst +++ b/classes/zh_CN/class_colorpalette.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ColorPalette.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPalette.xml. .. _class_ColorPalette: @@ -58,6 +58,7 @@ ColorPalette **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedColorArray` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_colorpicker.rst b/classes/zh_CN/class_colorpicker.rst index ce71d1a487..2a939b51c3 100644 --- a/classes/zh_CN/class_colorpicker.rst +++ b/classes/zh_CN/class_colorpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ColorPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPicker.xml. .. _class_ColorPicker: @@ -51,6 +51,8 @@ ColorPicker +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`edit_alpha` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`edit_intensity` | ``true`` | + +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`hex_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | @@ -92,49 +94,59 @@ ColorPicker .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`h_width` | ``30`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`label_width` | ``10`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`margin` | ``4`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_height` | ``256`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_width` | ``256`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`add_preset` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`bar_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`color_hue` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`expanded_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`folded_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`menu_option` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`overbright_indicator` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`picker_cursor` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`picker_cursor_bg` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`sample_bg` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`sample_revert` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`screen_picker` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_circle` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Color` | :ref:`focused_not_editing_cursor_color` | ``Color(1, 1, 1, 0.275)`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`h_width` | ``30`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`label_width` | ``10`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`margin` | ``4`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`sv_height` | ``256`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`sv_width` | ``256`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`add_preset` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`bar_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`color_hue` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`color_script` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`menu_option` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`overbright_indicator` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`picker_cursor` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`picker_cursor_bg` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`sample_bg` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`sample_revert` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`screen_picker` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_circle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_rect` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`picker_focus_circle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`picker_focus_rectangle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`sample_focus` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ .. rst-class:: classref-section-separator @@ -198,7 +210,7 @@ enum **ColorModeType**: :ref:`🔗` :ref:`ColorModeType` **MODE_RGB** = ``0`` -允许使用红、绿、蓝滑块编辑颜色。 +允许使用红、绿、蓝滑块在 sRGB 色彩空间中编辑颜色。 .. _class_ColorPicker_constant_MODE_HSV: @@ -214,7 +226,17 @@ enum **ColorModeType**: :ref:`🔗` :ref:`ColorModeType` **MODE_RAW** = ``2`` -允许颜色 R、G、B 分量值超过 1.0，这可用于某些需要它的特殊操作（例如在 HDR 中，着色而不变暗或渲染精灵）。 +**已弃用：** This is replaced by :ref:`MODE_LINEAR`. + + + +.. _class_ColorPicker_constant_MODE_LINEAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ColorModeType` **MODE_LINEAR** = ``2`` + +允许使用红、绿、蓝滑块在线性色彩空间中编辑颜色。 .. _class_ColorPicker_constant_MODE_OKHSL: @@ -278,6 +300,22 @@ HSL OK 颜色模型圆形色彩空间。 色彩空间形状和形状选择按钮被隐藏。不能从形状弹出窗口中选择。 +.. _class_ColorPicker_constant_SHAPE_OK_HS_RECTANGLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`PickerShapeType` **SHAPE_OK_HS_RECTANGLE** = ``5`` + +具有恒定亮度的 OKHSL 颜色模型矩形。 + +.. _class_ColorPicker_constant_SHAPE_OK_HL_RECTANGLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`PickerShapeType` **SHAPE_OK_HL_RECTANGLE** = ``6`` + +具有恒定饱和度的 OKHSL 颜色模型矩形。 + .. rst-class:: classref-section-separator ---- @@ -332,7 +370,7 @@ HSL OK 颜色模型圆形色彩空间。 - |void| **set_color_mode**\ (\ value\: :ref:`ColorModeType`\ ) - :ref:`ColorModeType` **get_color_mode**\ (\ ) -当前选择的颜色模式。见 :ref:`ColorModeType`\ 。 +当前选择的颜色模式。 .. rst-class:: classref-item-separator @@ -389,6 +427,23 @@ HSL OK 颜色模型圆形色彩空间。 ---- +.. _class_ColorPicker_property_edit_intensity: + +.. rst-class:: classref-property + +:ref:`bool` **edit_intensity** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_edit_intensity**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editing_intensity**\ (\ ) + +如果为 ``true`` 则显示强度滑块。强度的应用方法为：将颜色在线性 RGB 空间中乘以 ``2 ** intensity``\ ，然后转换回 sRGB。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_property_hex_visible: .. rst-class:: classref-property @@ -417,7 +472,7 @@ HSL OK 颜色模型圆形色彩空间。 - |void| **set_picker_shape**\ (\ value\: :ref:`PickerShapeType`\ ) - :ref:`PickerShapeType` **get_picker_shape**\ (\ ) -色彩空间视图的形状。见 :ref:`PickerShapeType`\ 。 +色彩空间视图的形状。 .. rst-class:: classref-item-separator @@ -560,6 +615,18 @@ HSL OK 颜色模型圆形色彩空间。 主题属性说明 ------------ +.. _class_ColorPicker_theme_color_focused_not_editing_cursor_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **focused_not_editing_cursor_color** = ``Color(1, 1, 1, 0.275)`` :ref:`🔗` + +当选择器的形状部分获得焦点但无法通过键盘或手柄编辑时，矩形或圆形的绘制颜色。该颜色显示在选择器形状\ *上方*\ ，因此应使用部分透明的颜色，确保选择器形状仍然可见。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_theme_constant_center_slider_grabbers: .. rst-class:: classref-themeproperty @@ -668,6 +735,18 @@ HSL OK 颜色模型圆形色彩空间。 ---- +.. _class_ColorPicker_theme_icon_color_script: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **color_script** :ref:`🔗` + +用于将颜色文本切换为十六进制的按钮的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_theme_icon_expanded_arrow: .. rst-class:: classref-themeproperty @@ -808,7 +887,44 @@ HSL OK 颜色模型圆形色彩空间。 矩形轮拾取器形状的图标。 +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_picker_focus_circle: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **picker_focus_circle** :ref:`🔗` + +拾取器的圆形部分处于聚焦状态时使用的 :ref:`StyleBox`\ 。显示在拾取器形状\ *之上*\ ，所以应该使用部分透明的 :ref:`StyleBox`\ ，确保拾取器形状仍然可见。代表轮廓或下划线的 :ref:`StyleBox` 可以很好地实现这个目的。要禁用聚焦的视觉效果，请指定 :ref:`StyleBoxEmpty` 资源。请注意，禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性，所以出于可访问性的原因，不建议这样做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_picker_focus_rectangle: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **picker_focus_rectangle** :ref:`🔗` + +拾取器的矩形部分处于聚焦状态时使用的 :ref:`StyleBox`\ 。显示在拾取器形状\ *之上*\ ，所以应该使用部分透明的 :ref:`StyleBox`\ ，确保拾取器形状仍然可见。代表轮廓或下划线的 :ref:`StyleBox` 可以很好地实现这个目的。要禁用聚焦的视觉效果，请指定 :ref:`StyleBoxEmpty` 资源。请注意，禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性，所以出于可访问性的原因，不建议这样做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_sample_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **sample_focus** :ref:`🔗` + +旧颜色样本部分处于聚焦状态时使用的 :ref:`StyleBox`\ 。显示在样本\ *之上*\ ，所以应该使用部分透明的 :ref:`StyleBox`\ ，确保拾取器形状仍然可见。代表轮廓或下划线的 :ref:`StyleBox` 可以很好地实现这个目的。要禁用聚焦的视觉效果，请指定 :ref:`StyleBoxEmpty` 资源。请注意，禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性，所以出于可访问性的原因，不建议这样做。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_colorpickerbutton.rst b/classes/zh_CN/class_colorpickerbutton.rst index b4da7889d0..501ff5cbc6 100644 --- a/classes/zh_CN/class_colorpickerbutton.rst +++ b/classes/zh_CN/class_colorpickerbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ColorPickerButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPickerButton.xml. .. _class_ColorPickerButton: @@ -42,13 +42,15 @@ ColorPickerButton .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | - +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`edit_alpha` | ``true`` | - +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | - +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | + +---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`edit_alpha` | ``true`` | + +---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`edit_intensity` | ``true`` | + +---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | + +---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -156,6 +158,23 @@ ColorPickerButton 如果为 ``true``\ ，则显示的 :ref:`ColorPicker` 中的 Alpha 通道将可见。 +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPickerButton_property_edit_intensity: + +.. rst-class:: classref-property + +:ref:`bool` **edit_intensity** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_edit_intensity**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editing_intensity**\ (\ ) + +如果为 ``true``\ ，则显示的 :ref:`ColorPicker` 中的强度滑块将可见。 + .. rst-class:: classref-section-separator ---- @@ -207,6 +226,7 @@ ColorPickerButton 颜色预览的背景将在按钮上显示。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_colorrect.rst b/classes/zh_CN/class_colorrect.rst index c9d02823b9..e06f69d6a7 100644 --- a/classes/zh_CN/class_colorrect.rst +++ b/classes/zh_CN/class_colorrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ColorRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorRect.xml. .. _class_ColorRect: @@ -63,6 +63,7 @@ ColorRect 该矩形的填充颜色。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compositor.rst b/classes/zh_CN/class_compositor.rst index 8557eb7d55..fdec28afd0 100644 --- a/classes/zh_CN/class_compositor.rst +++ b/classes/zh_CN/class_compositor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Compositor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Compositor.xml. .. _class_Compositor: @@ -65,6 +65,7 @@ Compositor 使用该合成器的视口在进行渲染时应用的自定义 :ref:`CompositorEffect`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compositoreffect.rst b/classes/zh_CN/class_compositoreffect.rst index 208f8e0e0a..c44a57ad9e 100644 --- a/classes/zh_CN/class_compositoreffect.rst +++ b/classes/zh_CN/class_compositoreffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompositorEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompositorEffect.xml. .. _class_CompositorEffect: @@ -312,6 +312,7 @@ enum **EffectCallbackType**: :ref:`🔗` 中指定的效果回调类型一致。可以通过 ``render_data`` 访问渲染状态，这个状态只有在渲染时有效，不应该存储。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedcubemap.rst b/classes/zh_CN/class_compressedcubemap.rst index 5a1b0f8b66..b1a25fd2d1 100644 --- a/classes/zh_CN/class_compressedcubemap.rst +++ b/classes/zh_CN/class_compressedcubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedCubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedCubemap.xml. .. _class_CompressedCubemap: @@ -38,6 +38,7 @@ CompressedCubemap 有关立方体贴图的一般描述，请参阅 :ref:`Cubemap`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedcubemaparray.rst b/classes/zh_CN/class_compressedcubemaparray.rst index ba1b702e77..9cc13e25bd 100644 --- a/classes/zh_CN/class_compressedcubemaparray.rst +++ b/classes/zh_CN/class_compressedcubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedCubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedCubemapArray.xml. .. _class_CompressedCubemapArray: @@ -38,6 +38,7 @@ CompressedCubemapArray 有关立方体贴图数组的一般说明，请参阅 :ref:`CubemapArray`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedtexture2d.rst b/classes/zh_CN/class_compressedtexture2d.rst index 0448609ac3..3212f4ebd6 100644 --- a/classes/zh_CN/class_compressedtexture2d.rst +++ b/classes/zh_CN/class_compressedtexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture2D.xml. .. _class_CompressedTexture2D: @@ -101,6 +101,7 @@ CompressedTexture2D 从指定的路径 ``path`` 加载纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedtexture2darray.rst b/classes/zh_CN/class_compressedtexture2darray.rst index 553249ac0a..a5075ba62b 100644 --- a/classes/zh_CN/class_compressedtexture2darray.rst +++ b/classes/zh_CN/class_compressedtexture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedTexture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture2DArray.xml. .. _class_CompressedTexture2DArray: @@ -38,6 +38,7 @@ CompressedTexture2DArray 有关纹理数组的一般描述，请参阅 :ref:`Texture2DArray`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedtexture3d.rst b/classes/zh_CN/class_compressedtexture3d.rst index 5f72a926bd..b9209ec710 100644 --- a/classes/zh_CN/class_compressedtexture3d.rst +++ b/classes/zh_CN/class_compressedtexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture3D.xml. .. _class_CompressedTexture3D: @@ -89,6 +89,7 @@ CompressedTexture3D 从指定的路径 ``path`` 加载纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_compressedtexturelayered.rst b/classes/zh_CN/class_compressedtexturelayered.rst index 1138b0ef48..8e5b922212 100644 --- a/classes/zh_CN/class_compressedtexturelayered.rst +++ b/classes/zh_CN/class_compressedtexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CompressedTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTextureLayered.xml. .. _class_CompressedTextureLayered: @@ -87,6 +87,7 @@ CompressedTextureLayered 加载位于 ``path`` 的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_concavepolygonshape2d.rst b/classes/zh_CN/class_concavepolygonshape2d.rst index 36bc8c097e..a8932681c1 100644 --- a/classes/zh_CN/class_concavepolygonshape2d.rst +++ b/classes/zh_CN/class_concavepolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConcavePolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConcavePolygonShape2D.xml. .. _class_ConcavePolygonShape2D: @@ -66,6 +66,7 @@ ConcavePolygonShape2D **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_concavepolygonshape3d.rst b/classes/zh_CN/class_concavepolygonshape3d.rst index 720b3d88ee..f03a671037 100644 --- a/classes/zh_CN/class_concavepolygonshape3d.rst +++ b/classes/zh_CN/class_concavepolygonshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConcavePolygonShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConcavePolygonShape3D.xml. .. _class_ConcavePolygonShape3D: @@ -114,6 +114,7 @@ ConcavePolygonShape3D 根据顶点数组设置三角网格形状的面。\ ``faces`` 数组应更多由若干三元组构成，每三个顶点定义一个三角形。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_conetwistjoint3d.rst b/classes/zh_CN/class_conetwistjoint3d.rst index 1496c7f6cc..3e54233df7 100644 --- a/classes/zh_CN/class_conetwistjoint3d.rst +++ b/classes/zh_CN/class_conetwistjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConeTwistJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConeTwistJoint3D.xml. .. _class_ConeTwistJoint3D: @@ -29,17 +29,17 @@ ConeTwistJoint3D .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`bias` | ``0.3`` | - +---------------------------+---------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`relaxation` | ``1.0`` | - +---------------------------+---------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`softness` | ``0.8`` | - +---------------------------+---------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`swing_span` | ``0.785398`` | - +---------------------------+---------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`twist_span` | ``3.14159`` | - +---------------------------+---------------------------------------------------------------+--------------+ + +---------------------------+---------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`bias` | ``0.3`` | + +---------------------------+---------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`relaxation` | ``1.0`` | + +---------------------------+---------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`softness` | ``0.8`` | + +---------------------------+---------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`swing_span` | ``0.7853982`` | + +---------------------------+---------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`twist_span` | ``3.1415927`` | + +---------------------------+---------------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group @@ -194,7 +194,7 @@ enum **Param**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **swing_span** = ``0.785398`` :ref:`🔗` +:ref:`float` **swing_span** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ enum **Param**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **twist_span** = ``3.14159`` :ref:`🔗` +:ref:`float` **twist_span** = ``3.1415927`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,6 +258,7 @@ enum **Param**: :ref:`🔗` 设置指定参数的值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_configfile.rst b/classes/zh_CN/class_configfile.rst index 5125ad7b3e..cd333255a7 100644 --- a/classes/zh_CN/class_configfile.rst +++ b/classes/zh_CN/class_configfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConfigFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConfigFile.xml. .. _class_ConfigFile: @@ -39,13 +39,13 @@ ConfigFile # 创建新的 ConfigFile 对象。 var config = ConfigFile.new() - + # 存储一些值。 config.set_value("Player1", "player_name", "Steve") config.set_value("Player1", "best_score", 10) config.set_value("Player2", "player_name", "V3geta") config.set_value("Player2", "best_score", 9001) - + # 将其保存到文件中（如果已存在则覆盖）。 config.save("user://scores.cfg") @@ -53,13 +53,13 @@ ConfigFile // 创建新的 ConfigFile 对象。 var config = new ConfigFile(); - + // 存储一些值。 config.SetValue("Player1", "player_name", "Steve"); config.SetValue("Player1", "best_score", 10); config.SetValue("Player2", "player_name", "V3geta"); config.SetValue("Player2", "best_score", 9001); - + // 将其保存到文件中（如果已存在则覆盖）。 config.Save("user://scores.cfg"); @@ -74,14 +74,14 @@ ConfigFile var score_data = {} var config = ConfigFile.new() - + # 从文件加载数据。 var err = config.load("user://scores.cfg") - + # 如果文件没有加载，忽略它。 if err != OK: return - + # 迭代所有小节。 for player in config.get_sections(): # 获取每个小节的数据。 @@ -93,16 +93,16 @@ ConfigFile var score_data = new Godot.Collections.Dictionary(); var config = new ConfigFile(); - + // 从文件加载数据。 Error err = config.Load("user://scores.cfg"); - + // 如果文件没有加载，忽略它。 if (err != Error.Ok) { return; } - + // 迭代所有小节。 foreach (String player in config.GetSections()) { @@ -390,6 +390,7 @@ ConfigFile 还可以包含以分号（\ ``;``\ ）开头的手动编写的注释 为指定小节的指定键赋值。如果小节或键不存在，则创建它们。如果指定的键存在，传递 ``null`` 值就会移除指定的键，如果键被移除后，小节最终是空的，就会移除小节。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_confirmationdialog.rst b/classes/zh_CN/class_confirmationdialog.rst index 175653c728..804a835415 100644 --- a/classes/zh_CN/class_confirmationdialog.rst +++ b/classes/zh_CN/class_confirmationdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConfirmationDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConfirmationDialog.xml. .. _class_ConfirmationDialog: @@ -110,6 +110,7 @@ ConfirmationDialog \ **警告：**\ 这是一个必需的内部节点，移除并释放它可能会导致崩溃。如果你希望隐藏它或其任何子项，请使用其 :ref:`CanvasItem.visible` 属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_container.rst b/classes/zh_CN/class_container.rst index cdf9c1c6ff..84e9e2a822 100644 --- a/classes/zh_CN/class_container.rst +++ b/classes/zh_CN/class_container.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Container.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Container.xml. .. _class_Container: @@ -12,7 +12,7 @@ Container **继承：** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**派生：** :ref:`AspectRatioContainer`, :ref:`BoxContainer`, :ref:`CenterContainer`, :ref:`EditorProperty`, :ref:`FlowContainer`, :ref:`GraphElement`, :ref:`GridContainer`, :ref:`MarginContainer`, :ref:`PanelContainer`, :ref:`ScrollContainer`, :ref:`SplitContainer`, :ref:`SubViewportContainer`, :ref:`TabContainer` +**派生：** :ref:`AspectRatioContainer`, :ref:`BoxContainer`, :ref:`CenterContainer`, :ref:`EditorProperty`, :ref:`FlowContainer`, :ref:`FoldableContainer`, :ref:`GraphElement`, :ref:`GridContainer`, :ref:`MarginContainer`, :ref:`PanelContainer`, :ref:`ScrollContainer`, :ref:`SplitContainer`, :ref:`SubViewportContainer`, :ref:`TabContainer` 所有 GUI 容器的基类。 @@ -172,6 +172,7 @@ Container 将子节点的重排加入队列。虽然会被自动调用，但也可以在需要时手动调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_control.rst b/classes/zh_CN/class_control.rst index 01dacbc5bc..9703d62336 100644 --- a/classes/zh_CN/class_control.rst +++ b/classes/zh_CN/class_control.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Control.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Control.xml. .. _class_Control: @@ -66,89 +66,107 @@ Godot 使用视口来传播输入事件。视口负责将 :ref:`InputEvent` | :ref:`anchor_bottom` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`anchor_left` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`anchor_right` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`anchor_top` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`auto_translate` | | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clip_contents` | ``false`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`custom_minimum_size` | ``Vector2(0, 0)`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_neighbor_bottom` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_neighbor_left` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_neighbor_right` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_neighbor_top` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`global_position` | | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`LayoutDirection` | :ref:`layout_direction` | ``0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`localize_numeral_system` | ``true`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`mouse_force_pass_scroll_events` | ``true`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`offset_bottom` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`offset_left` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`offset_right` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`offset_top` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`pivot_offset` | ``Vector2(0, 0)`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rotation` | ``0.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rotation_degrees` | | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`scale` | ``Vector2(1, 1)`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`shortcut_context` | | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_horizontal` | ``1`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_vertical` | ``1`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Theme` | :ref:`theme` | | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`theme_type_variation` | ``&""`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`AutoTranslateMode` | :ref:`tooltip_auto_translate_mode` | ``0`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tooltip_text` | ``""`` | - +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_controls_nodes` | ``[]`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_described_by_nodes` | ``[]`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`accessibility_description` | ``""`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_flow_to_nodes` | ``[]`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_labeled_by_nodes` | ``[]`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`AccessibilityLiveMode` | :ref:`accessibility_live` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`accessibility_name` | ``""`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_bottom` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_left` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_right` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_top` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`auto_translate` | | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clip_contents` | ``false`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`custom_minimum_size` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`FocusBehaviorRecursive` | :ref:`focus_behavior_recursive` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbor_bottom` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbor_left` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbor_right` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbor_top` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`global_position` | | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`LayoutDirection` | :ref:`layout_direction` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`localize_numeral_system` | ``true`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`MouseBehaviorRecursive` | :ref:`mouse_behavior_recursive` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`mouse_force_pass_scroll_events` | ``true`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`offset_bottom` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`offset_left` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`offset_right` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`offset_top` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`pivot_offset` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rotation` | ``0.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rotation_degrees` | | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`scale` | ``Vector2(1, 1)`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`shortcut_context` | | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_horizontal` | ``1`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_vertical` | ``1`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Theme` | :ref:`theme` | | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`theme_type_variation` | ``&""`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`tooltip_auto_translate_mode` | ``0`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tooltip_text` | ``""`` | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -158,11 +176,15 @@ Godot 使用视口来传播输入事件。视口负责将 :ref:`InputEvent` | :ref:`_accessibility_get_contextual_info`\ (\ ) |virtual| |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_drop_data`\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_drop_data`\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_accessibility_container_name`\ (\ node\: :ref:`Node`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_drag_data`\ (\ at_position\: :ref:`Vector2`\ ) |virtual| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_get_minimum_size`\ (\ ) |virtual| |const| | @@ -179,6 +201,10 @@ Godot 使用视口来传播输入事件。视口负责将 :ref:`InputEvent`\ (\ ) | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_drag`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_drop`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_theme_color_override`\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_theme_constant_override`\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) | @@ -213,12 +239,16 @@ Godot 使用视口来传播输入事件。视口负责将 :ref:`InputEvent` | :ref:`get_end`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FocusMode` | :ref:`get_focus_mode_with_override`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_focus_neighbor`\ (\ side\: :ref:`Side`\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MouseFilter` | :ref:`get_mouse_filter_with_override`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_offset`\ (\ offset\: :ref:`Side`\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_parent_area_size`\ (\ ) |const| | @@ -496,6 +526,82 @@ enum **FocusMode**: :ref:`🔗` 该节点可以通过鼠标单击、使用键盘上的箭头和 Tab 键或使用游戏手柄上的方向键来获取焦点。用于 :ref:`focus_mode`\ 。 +.. _class_Control_constant_FOCUS_ACCESSIBILITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`FocusMode` **FOCUS_ACCESSIBILITY** = ``3`` + +该节点只能在屏幕阅读器活动时获取焦点。在 :ref:`focus_mode` 中使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Control_FocusBehaviorRecursive: + +.. rst-class:: classref-enumeration + +enum **FocusBehaviorRecursive**: :ref:`🔗` + +.. _class_Control_constant_FOCUS_BEHAVIOR_INHERITED: + +.. rst-class:: classref-enumeration-constant + +:ref:`FocusBehaviorRecursive` **FOCUS_BEHAVIOR_INHERITED** = ``0`` + +继承父控件的 :ref:`focus_behavior_recursive`\ 。没有父控件时与 :ref:`FOCUS_BEHAVIOR_ENABLED` 相同。 + +.. _class_Control_constant_FOCUS_BEHAVIOR_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`FocusBehaviorRecursive` **FOCUS_BEHAVIOR_DISABLED** = ``1`` + +阻止控件获取焦点。\ :ref:`get_focus_mode_with_override()` 会返回 :ref:`FOCUS_NONE`\ 。 + +.. _class_Control_constant_FOCUS_BEHAVIOR_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`FocusBehaviorRecursive` **FOCUS_BEHAVIOR_ENABLED** = ``2`` + +允许控件获取焦点，取决于 :ref:`focus_mode`\ 。可以用来忽略父控件的 :ref:`focus_behavior_recursive`\ 。\ :ref:`get_focus_mode_with_override()` 会返回 :ref:`focus_mode`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Control_MouseBehaviorRecursive: + +.. rst-class:: classref-enumeration + +enum **MouseBehaviorRecursive**: :ref:`🔗` + +.. _class_Control_constant_MOUSE_BEHAVIOR_INHERITED: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseBehaviorRecursive` **MOUSE_BEHAVIOR_INHERITED** = ``0`` + +继承父控件的 :ref:`mouse_behavior_recursive`\ 。没有父控件时与 :ref:`MOUSE_BEHAVIOR_ENABLED` 相同。 + +.. _class_Control_constant_MOUSE_BEHAVIOR_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseBehaviorRecursive` **MOUSE_BEHAVIOR_DISABLED** = ``1`` + +阻止控件获取鼠标输入。\ :ref:`get_mouse_filter_with_override()` 会返回 :ref:`MOUSE_FILTER_IGNORE`\ 。 + +.. _class_Control_constant_MOUSE_BEHAVIOR_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseBehaviorRecursive` **MOUSE_BEHAVIOR_ENABLED** = ``2`` + +允许控件获取鼠标输入，取决于 :ref:`mouse_filter`\ 。可以用来忽略父控件的 :ref:`mouse_behavior_recursive`\ 。\ :ref:`get_mouse_filter_with_override()` 会返回 :ref:`mouse_filter`\ 。 + .. rst-class:: classref-item-separator ---- @@ -1028,7 +1134,7 @@ enum **LayoutDirection**: :ref:`🔗` :ref:`LayoutDirection` **LAYOUT_DIRECTION_SYSTEM_LOCALE** = ``4`` -自动排版方向，由系统区域设置决定。阿拉伯语和希伯来语等语言会自动使用从右至左的排版方向，但前提是加载了该语言的有效翻译文件。其他所有语言（或者 Godot 未找到有效的翻译文件）都会使用从左至右的排版方向。如果使用的是 :ref:`TextServerFallback`\ （\ :ref:`ProjectSettings.internationalization/rendering/text_driver`\ ），则所有语言都会使用从左至右的排版方向。 +Automatic layout direction, determined from the system locale. Right-to-left layout direction is automatically used for languages that require it such as Arabic and Hebrew, but only if a valid translation file is loaded for the given language. For all other languages (or if no valid translation file is found by Godot), left-to-right layout direction is used. If using :ref:`TextServerFallback` (:ref:`ProjectSettings.internationalization/rendering/text_driver`), left-to-right layout direction is always used regardless of the language. .. _class_Control_constant_LAYOUT_DIRECTION_MAX: @@ -1240,6 +1346,125 @@ enum **TextDirection**: :ref:`🔗` 属性说明 -------- +.. _class_Control_property_accessibility_controls_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_controls_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_controls_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_controls_nodes**\ (\ ) + +到被该节点控制的节点的路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_described_by_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_described_by_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_described_by_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_described_by_nodes**\ (\ ) + +到描述该节点的节点的路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_description: + +.. rst-class:: classref-property + +:ref:`String` **accessibility_description** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_description**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_accessibility_description**\ (\ ) + +报告给辅助应用的人类可读节点描述。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_flow_to_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_flow_to_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_flow_to_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_flow_to_nodes**\ (\ ) + +到该节点流入的节点的路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_labeled_by_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_labeled_by_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_labeled_by_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_labeled_by_nodes**\ (\ ) + +到标签标注该节点的节点的路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_live: + +.. rst-class:: classref-property + +:ref:`AccessibilityLiveMode` **accessibility_live** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_live**\ (\ value\: :ref:`AccessibilityLiveMode`\ ) +- :ref:`AccessibilityLiveMode` **get_accessibility_live**\ (\ ) + +实时区域的更新模式，实时区域是一个 :ref:`Node`\ ，当用户的焦点可能位于其他位置时，它会因外部事件而更新。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_property_accessibility_name: + +.. rst-class:: classref-property + +:ref:`String` **accessibility_name** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_accessibility_name**\ (\ ) + +报告给辅助应用的人类可读节点名称。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_property_anchor_bottom: .. rst-class:: classref-property @@ -1315,7 +1540,7 @@ enum **TextDirection**: :ref:`🔗` - |void| **set_auto_translate**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_auto_translating**\ (\ ) -**已弃用：** Use :ref:`Node.auto_translate_mode` instead. +**已弃用：** Use :ref:`Node.auto_translate_mode` and :ref:`Node.can_auto_translate()` instead. 切换是否所有文本都应该根据当前区域设置自动变为翻译后的版本。 @@ -1357,6 +1582,23 @@ enum **TextDirection**: :ref:`🔗` ---- +.. _class_Control_property_focus_behavior_recursive: + +.. rst-class:: classref-property + +:ref:`FocusBehaviorRecursive` **focus_behavior_recursive** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_focus_behavior_recursive**\ (\ value\: :ref:`FocusBehaviorRecursive`\ ) +- :ref:`FocusBehaviorRecursive` **get_focus_behavior_recursive**\ (\ ) + +决定哪些控件可以根据 :ref:`focus_mode` 一起聚焦。见 :ref:`get_focus_mode_with_override()`\ 。由于默认行为是 :ref:`FOCUS_BEHAVIOR_INHERITED`\ ，可以用来阻止聚焦子控件。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_property_focus_mode: .. rst-class:: classref-property @@ -1368,7 +1610,7 @@ enum **TextDirection**: :ref:`🔗` - |void| **set_focus_mode**\ (\ value\: :ref:`FocusMode`\ ) - :ref:`FocusMode` **get_focus_mode**\ (\ ) -该控件的焦点访问模式（“无”“单击”或“全部”）。只能同时聚焦一个控件，该控件会收到键盘、手柄以及鼠标的信号。 +决定可以聚焦哪些控件。同一时间只能聚焦一个控件，聚焦的控件将在 :ref:`_gui_input()` 中收到键盘、游戏手柄和鼠标事件。请使用 :ref:`get_focus_mode_with_override()` 来确定控件是否可以获取焦点，因为 :ref:`focus_behavior_recursive` 也会对其产生影响。另见 :ref:`grab_focus()`\ 。 .. rst-class:: classref-item-separator @@ -1566,6 +1808,23 @@ enum **TextDirection**: :ref:`🔗` ---- +.. _class_Control_property_mouse_behavior_recursive: + +.. rst-class:: classref-property + +:ref:`MouseBehaviorRecursive` **mouse_behavior_recursive** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mouse_behavior_recursive**\ (\ value\: :ref:`MouseBehaviorRecursive`\ ) +- :ref:`MouseBehaviorRecursive` **get_mouse_behavior_recursive**\ (\ ) + +决定哪些控件可以根据 :ref:`mouse_filter` 一起接收鼠标输入。见 :ref:`get_mouse_filter_with_override()`\ 。由于默认行为是 :ref:`MOUSE_BEHAVIOR_INHERITED`\ ，可以用来阻止所有子控件接收鼠标输入。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_property_mouse_default_cursor_shape: .. rst-class:: classref-property @@ -1596,7 +1855,7 @@ enum **TextDirection**: :ref:`🔗` - |void| **set_mouse_filter**\ (\ value\: :ref:`MouseFilter`\ ) - :ref:`MouseFilter` **get_mouse_filter**\ (\ ) -控制控件是否能够通过 :ref:`_gui_input()` 接收鼠标按钮输入事件，以及如何处理这些事件。还控制控件是否能接收 :ref:`mouse_entered` 和 :ref:`mouse_exited` 信号。参阅常量来了解每个常量的作用。 +决定哪些控件可以通过 :ref:`_gui_input()` 以及 :ref:`mouse_entered` 和 :ref:`mouse_exited` 信号接收鼠标按键输入事件。还决定了这些事件应该如何传播。不同的行为见常量。请使用 :ref:`get_mouse_filter_with_override()` 来确定控件是否可以收到鼠标输入，因为 :ref:`mouse_behavior_recursive` 也会对其产生影响。 .. rst-class:: classref-item-separator @@ -1779,7 +2038,7 @@ enum **TextDirection**: :ref:`🔗` - |void| **set_scale**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_scale**\ (\ ) -节点的缩放，相对于它的 :ref:`size`\ 。更改该属性会以节点的 :ref:`pivot_offset` 为中心进行缩放。该 Control 的 :ref:`tooltip_text` 也将根据该值进行缩放。 +节点的缩放，相对于它的 :ref:`size`\ 。更改该属性会以节点的 :ref:`pivot_offset` 为中心进行缩放。该 Control 的工具提示也将根据该值进行缩放。 \ **注意：**\ 该属性主要用于动画用途。要在项目中支持多种分辨率，请使用 :doc:`文档 <../tutorials/rendering/multiple_resolutions>` 中所述的合适的视口拉伸模式，不要单独缩放控件。 @@ -1985,15 +2244,29 @@ enum **TextDirection**: :ref:`🔗` 方法说明 -------- +.. _class_Control_private_method__accessibility_get_contextual_info: + +.. rst-class:: classref-method + +:ref:`String` **_accessibility_get_contextual_info**\ (\ ) |virtual| |const| :ref:`🔗` + +返回键盘快捷键的描述以及针对该控件的其他上下文帮助信息。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_private_method__can_drop_data: .. rst-class:: classref-method :ref:`bool` **_can_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` -Godot 调用这个方法来检查是否能够将来自某个控件 :ref:`_get_drag_data()` 方法的 ``data`` 拖放到 ``at_position``\ 。\ ``at_position`` 使用的是这个控件的局部坐标系。 +Godot 调用这个方法来检查是否能够将来自某个控件 :ref:`_get_drag_data()` 方法的 ``data`` 放置到 ``at_position`` 位置。\ ``at_position`` 使用的是这个控件的局部坐标系。 -这个方法应该只用于检查数据。请在 :ref:`_drop_data()` 中处理数据。 +这个方法只应对数据进行检查。处理数据请在 :ref:`_drop_data()` 中进行。 + +\ **注意：**\ 如果拖动是由键盘快捷键或 :ref:`accessibility_drag()` 发起的，则 ``at_position`` 会被设置为 :ref:`Vector2.INF`\ ，且应当使用当前选中项/文本的位置作为放置位置。 .. tabs:: @@ -2026,7 +2299,9 @@ Godot 调用这个方法来检查是否能够将来自某个控件 :ref:`_get_dr |void| **_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` -Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_get_drag_data()` 获得的结果。Godot 首先会调用 :ref:`_can_drop_data()` 来检查是否允许把 ``data`` 拖放到 ``at_position``\ ，这里的 ``at_position`` 使用的是这个控件的局部坐标系。 +Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_get_drag_data()` 获得的结果。Godot 首先会调用 :ref:`_can_drop_data()` 来检查是否允许把 ``data`` 放置到 ``at_position``\ ，这里的 ``at_position`` 使用的是这个控件的局部坐标系。 + +\ **注意：**\ 如果拖动是由键盘快捷键或 :ref:`accessibility_drag()` 发起的，则 ``at_position`` 会被设置为 :ref:`Vector2.INF`\ ，且应当使用当前选中项/文本的位置作为放置位置。 .. tabs:: @@ -2035,7 +2310,7 @@ Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_ge func _can_drop_data(position, data): return typeof(data) == TYPE_DICTIONARY and data.has("color") - + func _drop_data(position, data): var color = data["color"] @@ -2045,7 +2320,7 @@ Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_ge { return data.VariantType == Variant.Type.Dictionary && data.AsGodotDictionary().ContainsKey("color"); } - + public override void _DropData(Vector2 atPosition, Variant data) { Color color = data.AsGodotDictionary()["color"].AsColor(); @@ -2053,6 +2328,18 @@ Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_ge +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_private_method__get_accessibility_container_name: + +.. rst-class:: classref-method + +:ref:`String` **_get_accessibility_container_name**\ (\ node\: :ref:`Node`\ ) |virtual| |const| :ref:`🔗` + +覆盖该方法以返回子 ``node`` 在自定义容器中的位置的人类可读描述，并将其添加到 :ref:`accessibility_name`\ 。 + .. rst-class:: classref-item-separator ---- @@ -2063,9 +2350,11 @@ Godot 调用该方法把 ``data`` 传给你，这是从某个控件的 :ref:`_ge :ref:`Variant` **_get_drag_data**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` -Godot 调用该方法来获取数据，这个数据将用于拖动操作，放置到期望放置数据的控件上。如果没有要拖动的数据，则返回 ``null``\ 。想要接收拖放数据的控件应该实现 :ref:`_can_drop_data()` 和 :ref:`_drop_data()`\ 。\ ``at_position`` 是该控件的局部位置。可以使用 :ref:`force_drag()` 强制拖动。 +Godot 调用该方法来获取数据，该数据可以被拖放到那些期望放置数据的控件上。如果没有要拖动的数据，则返回 ``null``\ 。想要接收放置数据的控件应该实现 :ref:`_can_drop_data()` 和 :ref:`_drop_data()`\ 。\ ``at_position`` 是该控件的局部位置。可以使用 :ref:`force_drag()` 强制拖动。 -可以使用 :ref:`set_drag_preview()` 设置跟随鼠标显示数据的预览。本方法中非常适合设置这个预览。 +可以使用 :ref:`set_drag_preview()` 设置代表数据跟随鼠标移动的预览。设置预览的不错时机就是在这个方法中。 + +\ **注意：**\ 如果拖动是由键盘快捷键或 :ref:`accessibility_drag()` 发起的，则 ``at_position`` 会被设置为 :ref:`Vector2.INF`\ ，且应当使用当前选中项/文本的位置作为拖动位置。 .. tabs:: @@ -2287,6 +2576,30 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 ---- +.. _class_Control_method_accessibility_drag: + +.. rst-class:: classref-method + +|void| **accessibility_drag**\ (\ ) :ref:`🔗` + +不使用鼠标开启拖放操作。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_method_accessibility_drop: + +.. rst-class:: classref-method + +|void| **accessibility_drop**\ (\ ) :ref:`🔗` + +不使用鼠标结束拖放操作。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_add_theme_color_override: .. rst-class:: classref-method @@ -2545,7 +2858,7 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 :ref:`CursorShape` **get_cursor_shape**\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` -返回控件在鼠标悬停时显示的鼠标指针形状。见 :ref:`CursorShape`\ 。 +返回悬停在该控件局部坐标 ``position`` 上时鼠标光标的形状。对于大多数控件而言，与 :ref:`mouse_default_cursor_shape` 相同，但部分内置控件会实现更复杂的逻辑。 .. rst-class:: classref-item-separator @@ -2563,6 +2876,18 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 ---- +.. _class_Control_method_get_focus_mode_with_override: + +.. rst-class:: classref-method + +:ref:`FocusMode` **get_focus_mode_with_override**\ (\ ) |const| :ref:`🔗` + +返回 :ref:`focus_mode`\ ，但还会考虑 :ref:`focus_behavior_recursive`\ 。如果 :ref:`focus_behavior_recursive` 为 :ref:`FOCUS_BEHAVIOR_DISABLED`\ ，或为 :ref:`FOCUS_BEHAVIOR_INHERITED` 且祖先为 :ref:`FOCUS_BEHAVIOR_DISABLED`\ ，则会返回 :ref:`FOCUS_NONE`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_get_focus_neighbor: .. rst-class:: classref-method @@ -2605,6 +2930,18 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 ---- +.. _class_Control_method_get_mouse_filter_with_override: + +.. rst-class:: classref-method + +:ref:`MouseFilter` **get_mouse_filter_with_override**\ (\ ) |const| :ref:`🔗` + +返回 :ref:`mouse_filter`\ ，但还会考虑 :ref:`mouse_behavior_recursive`\ 。如果 :ref:`mouse_behavior_recursive` 为 :ref:`MOUSE_BEHAVIOR_DISABLED`\ ，或为 :ref:`MOUSE_BEHAVIOR_INHERITED` 且祖先为 :ref:`MOUSE_BEHAVIOR_DISABLED`\ ，则会返回 :ref:`MOUSE_FILTER_IGNORE`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_get_offset: .. rst-class:: classref-method @@ -3289,7 +3626,7 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 .. code-tab:: gdscript @export var color = Color(1, 0, 0, 1) - + func _get_drag_data(position): #使用不在树中的控件 var cpb = ColorPickerButton.new() @@ -3302,7 +3639,7 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 [Export] private Color _color = new Color(1, 0, 0, 1); - + public override Variant _GetDragData(Vector2 atPosition) { // 使用不在树中的控件 @@ -3436,6 +3773,7 @@ Godot 调用该方法来获取数据，这个数据将用于拖动操作，放 \ **注意：**\ :ref:`warp_mouse()` 仅在 Windows、macOS 和 Linux 上受支持。它在 Android、iOS 和 Web 上没有效果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_converttransformmodifier3d.rst b/classes/zh_CN/class_converttransformmodifier3d.rst new file mode 100644 index 0000000000..06cf7fa7dc --- /dev/null +++ b/classes/zh_CN/class_converttransformmodifier3d.rst @@ -0,0 +1,426 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConvertTransformModifier3D.xml. + +.. _class_ConvertTransformModifier3D: + +ConvertTransformModifier3D +========================== + +**继承：** :ref:`BoneConstraint3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +对骨骼应用变换的 :ref:`SkeletonModifier3D`\ ，变换转换自参考骨骼。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +从通过 :ref:`BoneConstraint3D.set_reference_bone()` 指定的骨骼上复制变换，将所复制的变换沿特定轴应用到通过 :ref:`BoneConstraint3D.set_apply_bone()` 设置的骨骼上，并可使用一些选项对这个变换进行调整。 + +根据 :ref:`set_relative()`\ （相对）和 :ref:`set_additive()`\ （叠加）的组合，有四种方式可以应用该变换： + +\ **相对 + 叠加**\ ： + +- 提取相对于静止姿态的参考姿态，并将其添加到目标骨骼的姿态上。 + +\ **相对 + 非叠加：**\ + +- 提取相对于静止姿态的参考姿态，并将其添加到目标骨骼的静止姿态上。 + +\ **非相对 + 叠加：**\ + +- 提取参考姿态的绝对姿态，并将其添加到目标骨骼的姿态上。 + +\ **非相对 + 非叠加**\ ： + +- 提取参考姿态的绝对姿态，并将其替换目标骨骼的姿态。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------+-------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-----------------------+-------------------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Axis` | :ref:`get_apply_axis`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_apply_range_max`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_apply_range_min`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransformMode` | :ref:`get_apply_transform_mode`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Axis` | :ref:`get_reference_axis`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_reference_range_max`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_reference_range_min`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransformMode` | :ref:`get_reference_transform_mode`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_additive`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additive`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_range_max`\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_range_min`\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_transform_mode`\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_range_max`\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_range_min`\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_transform_mode`\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_relative`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_ConvertTransformModifier3D_TransformMode: + +.. rst-class:: classref-enumeration + +enum **TransformMode**: :ref:`🔗` + +.. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_POSITION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformMode` **TRANSFORM_MODE_POSITION** = ``0`` + +转换时使用位置。传递差值。 + +.. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_ROTATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformMode` **TRANSFORM_MODE_ROTATION** = ``1`` + +转换时使用旋转。角度是指定轴的翻滚值。 + +.. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformMode` **TRANSFORM_MODE_SCALE** = ``2`` + +转换时使用缩放。传递比例而不是差值。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_ConvertTransformModifier3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +修改器中设置的数量。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_ConvertTransformModifier3D_method_get_apply_axis: + +.. rst-class:: classref-method + +:ref:`Axis` **get_apply_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射目标变换的轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_apply_range_max: + +.. rst-class:: classref-method + +:ref:`float` **get_apply_range_max**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射目标范围的最大值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_apply_range_min: + +.. rst-class:: classref-method + +:ref:`float` **get_apply_range_min**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射目标范围的最小值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_apply_transform_mode: + +.. rst-class:: classref-method + +:ref:`TransformMode` **get_apply_transform_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射目标变换的操作。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_reference_axis: + +.. rst-class:: classref-method + +:ref:`Axis` **get_reference_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射来源变换的轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_reference_range_max: + +.. rst-class:: classref-method + +:ref:`float` **get_reference_range_max**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射来源范围的最大值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_reference_range_min: + +.. rst-class:: classref-method + +:ref:`float` **get_reference_range_min**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射来源范围的最小值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_get_reference_transform_mode: + +.. rst-class:: classref-method + +:ref:`TransformMode` **get_reference_transform_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回重映射来源变换的操作。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_is_additive: + +.. rst-class:: classref-method + +:ref:`bool` **is_additive**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置启用了加法选项，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_is_relative: + +.. rst-class:: classref-method + +:ref:`bool` **is_relative**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置启用了相对选项，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_additive: + +.. rst-class:: classref-method + +|void| **set_additive**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的叠加选项设置为 ``enabled``\ 。主要影响对 :ref:`BoneConstraint3D.set_apply_bone()` 施加变换的过程。 + +如果将 ``enabled`` 设置为 ``true``\ ，则会将处理后的变换叠加到当前应用骨骼的姿势之上。 + +如果将 ``enabled`` 设置为 ``false``\ ，则会将当前应用骨骼的姿势替换为处理后的变换。不过如果将 :ref:`set_relative()` 设为 ``true``\ ，则该变换是相对于放松姿势的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_apply_axis: + +.. rst-class:: classref-method + +|void| **set_apply_axis**\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) :ref:`🔗` + +设置重映射目标变换的轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_apply_range_max: + +.. rst-class:: classref-method + +|void| **set_apply_range_max**\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) :ref:`🔗` + +设置重映射目标范围的最大值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_apply_range_min: + +.. rst-class:: classref-method + +|void| **set_apply_range_min**\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) :ref:`🔗` + +设置重映射目标范围的最小值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_apply_transform_mode: + +.. rst-class:: classref-method + +|void| **set_apply_transform_mode**\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) :ref:`🔗` + +设置重映射目标变换的操作。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_reference_axis: + +.. rst-class:: classref-method + +|void| **set_reference_axis**\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) :ref:`🔗` + +设置重映射来源变换的轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_reference_range_max: + +.. rst-class:: classref-method + +|void| **set_reference_range_max**\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) :ref:`🔗` + +设置重映射来源范围的最大值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_reference_range_min: + +.. rst-class:: classref-method + +|void| **set_reference_range_min**\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) :ref:`🔗` + +设置重映射来源范围的最小值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_reference_transform_mode: + +.. rst-class:: classref-method + +|void| **set_reference_transform_mode**\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) :ref:`🔗` + +设置重映射来源变换的操作。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ConvertTransformModifier3D_method_set_relative: + +.. rst-class:: classref-method + +|void| **set_relative**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的相对选项设置为 ``enabled``\ 。 + +如果将 ``enabled`` 设置为 ``true``\ ，则提取并应用的变换是相对于放松姿势的。 + +如果将 ``enabled`` 设置为 ``false``\ ，则提取到的变换是绝对的。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_convexpolygonshape2d.rst b/classes/zh_CN/class_convexpolygonshape2d.rst index 0b8d9bafe6..7c32f3fc70 100644 --- a/classes/zh_CN/class_convexpolygonshape2d.rst +++ b/classes/zh_CN/class_convexpolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConvexPolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConvexPolygonShape2D.xml. .. _class_ConvexPolygonShape2D: @@ -95,6 +95,7 @@ ConvexPolygonShape2D 根据提供的点集，使用凸包算法分配 :ref:`points` 属性，移除所有不必要的点。详见 :ref:`Geometry2D.convex_hull()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_convexpolygonshape3d.rst b/classes/zh_CN/class_convexpolygonshape3d.rst index 7ab29da95b..90c0974072 100644 --- a/classes/zh_CN/class_convexpolygonshape3d.rst +++ b/classes/zh_CN/class_convexpolygonshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ConvexPolygonShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConvexPolygonShape3D.xml. .. _class_ConvexPolygonShape3D: @@ -71,6 +71,7 @@ ConvexPolygonShape3D **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_copytransformmodifier3d.rst b/classes/zh_CN/class_copytransformmodifier3d.rst new file mode 100644 index 0000000000..9741f90074 --- /dev/null +++ b/classes/zh_CN/class_copytransformmodifier3d.rst @@ -0,0 +1,594 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CopyTransformModifier3D.xml. + +.. _class_CopyTransformModifier3D: + +CopyTransformModifier3D +======================= + +**继承：** :ref:`BoneConstraint3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +对骨骼应用变换的 :ref:`SkeletonModifier3D`\ ，变换复制自参考骨骼。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +从通过 :ref:`BoneConstraint3D.set_reference_bone()` 指定的骨骼上复制变换，将所复制的变换应用到通过 :ref:`BoneConstraint3D.set_apply_bone()` 设置的骨骼上，并可使用一些遮罩和选项对这个过程进行调整。 + +根据 :ref:`set_relative()`\ （相对）和 :ref:`set_additive()`\ （叠加）的组合，有四种方式可以应用该变换： + +\ **相对 + 叠加**\ ： + +- 提取相对于静止姿态的参考姿态，并将其添加到目标骨骼的姿态上。 + +\ **相对 + 非叠加：**\ + +- 提取相对于静止姿态的参考姿态，并将其添加到目标骨骼的静止姿态上。 + +\ **非相对 + 叠加：**\ + +- 提取参考姿态的绝对姿态，并将其添加到目标骨骼的姿态上。 + +\ **非相对 + 非叠加**\ ： + +- 提取参考姿态的绝对姿态，并将其替换目标骨骼的姿态。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------+----------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-----------------------+----------------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`AxisFlag`\] | :ref:`get_axis_flags`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`TransformFlag`\] | :ref:`get_copy_flags`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`AxisFlag`\] | :ref:`get_invert_flags`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_additive`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_x_enabled`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_x_inverted`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_y_enabled`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_y_inverted`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_z_enabled`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_axis_z_inverted`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_position_copying`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_rotation_copying`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_scale_copying`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additive`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_flags`\ (\ index\: :ref:`int`, axis_flags\: |bitfield|\[:ref:`AxisFlag`\]\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_x_enabled`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_x_inverted`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_y_enabled`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_y_inverted`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_z_enabled`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_z_inverted`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_copy_flags`\ (\ index\: :ref:`int`, copy_flags\: |bitfield|\[:ref:`TransformFlag`\]\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_copy_position`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_copy_rotation`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_copy_scale`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_invert_flags`\ (\ index\: :ref:`int`, axis_flags\: |bitfield|\[:ref:`AxisFlag`\]\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_relative`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_CopyTransformModifier3D_TransformFlag: + +.. rst-class:: classref-enumeration + +flags **TransformFlag**: :ref:`🔗` + +.. _class_CopyTransformModifier3D_constant_TRANSFORM_FLAG_POSITION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformFlag` **TRANSFORM_FLAG_POSITION** = ``1`` + +如果设置，则会允许复制位置。 + +.. _class_CopyTransformModifier3D_constant_TRANSFORM_FLAG_ROTATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformFlag` **TRANSFORM_FLAG_ROTATION** = ``2`` + +如果设置，则会允许复制旋转。 + +.. _class_CopyTransformModifier3D_constant_TRANSFORM_FLAG_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformFlag` **TRANSFORM_FLAG_SCALE** = ``4`` + +如果设置，则会允许复制缩放。 + +.. _class_CopyTransformModifier3D_constant_TRANSFORM_FLAG_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransformFlag` **TRANSFORM_FLAG_ALL** = ``7`` + +如果设置，则会允许复制位置、旋转、缩放。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_CopyTransformModifier3D_AxisFlag: + +.. rst-class:: classref-enumeration + +flags **AxisFlag**: :ref:`🔗` + +.. _class_CopyTransformModifier3D_constant_AXIS_FLAG_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`AxisFlag` **AXIS_FLAG_X** = ``1`` + +如果设置，则会允许处理 X 轴。 + +.. _class_CopyTransformModifier3D_constant_AXIS_FLAG_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`AxisFlag` **AXIS_FLAG_Y** = ``2`` + +如果设置，则会允许处理 Y 轴。 + +.. _class_CopyTransformModifier3D_constant_AXIS_FLAG_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`AxisFlag` **AXIS_FLAG_Z** = ``4`` + +如果设置，则会允许处理 Z 轴。 + +.. _class_CopyTransformModifier3D_constant_AXIS_FLAG_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`AxisFlag` **AXIS_FLAG_ALL** = ``7`` + +如果设置，则会允许处理所有轴。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_CopyTransformModifier3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +修改器中设置的数量。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_CopyTransformModifier3D_method_get_axis_flags: + +.. rst-class:: classref-method + +|bitfield|\[:ref:`AxisFlag`\] **get_axis_flags**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的轴标志。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_get_copy_flags: + +.. rst-class:: classref-method + +|bitfield|\[:ref:`TransformFlag`\] **get_copy_flags**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的复制标志。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_get_invert_flags: + +.. rst-class:: classref-method + +|bitfield|\[:ref:`AxisFlag`\] **get_invert_flags**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的设置的翻转标志。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_additive: + +.. rst-class:: classref-method + +:ref:`bool` **is_additive**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置启用了加法选项，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_x_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_x_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的启用标志中存在 X 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_axis_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_x_inverted: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_x_inverted**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的翻转标志中存在 X 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_invert_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_y_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_y_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的启用标志中存在 Y 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_axis_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_y_inverted: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_y_inverted**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的翻转标志中存在 Y 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_invert_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_z_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_z_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的启用标志中存在 Z 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_axis_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_axis_z_inverted: + +.. rst-class:: classref-method + +:ref:`bool` **is_axis_z_inverted**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的翻转标志中存在 Z 轴对应的标志，则返回 ``true``\ 。另见 :ref:`set_invert_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_position_copying: + +.. rst-class:: classref-method + +:ref:`bool` **is_position_copying**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的复制标志中存在位置对应的标志，则返回 ``true``\ 。另见 :ref:`set_copy_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_relative: + +.. rst-class:: classref-method + +:ref:`bool` **is_relative**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置启用了相对选项，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_rotation_copying: + +.. rst-class:: classref-method + +:ref:`bool` **is_rotation_copying**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的复制标志中存在旋转对应的标志，则返回 ``true``\ 。另见 :ref:`set_copy_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_is_scale_copying: + +.. rst-class:: classref-method + +:ref:`bool` **is_scale_copying**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果索引为 ``index`` 的设置的复制标志中存在缩放对应的标志，则返回 ``true``\ 。另见 :ref:`set_copy_flags()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_additive: + +.. rst-class:: classref-method + +|void| **set_additive**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的叠加选项设置为 ``enabled``\ 。主要影响对 :ref:`BoneConstraint3D.set_apply_bone()` 施加变换的过程。 + +如果将 ``enabled`` 设置为 ``true``\ ，则会将处理后的变换叠加到当前应用骨骼的姿势之上。 + +如果将 ``enabled`` 设置为 ``false``\ ，则会将当前应用骨骼的姿势替换为处理后的变换。不过如果将 :ref:`set_relative()` 设为 ``true``\ ，则该变换是相对于放松姿势的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_flags: + +.. rst-class:: classref-method + +|void| **set_axis_flags**\ (\ index\: :ref:`int`, axis_flags\: |bitfield|\[:ref:`AxisFlag`\]\ ) :ref:`🔗` + +设置复制轴标志。如果标志有效，则会复制对应的轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_x_enabled: + +.. rst-class:: classref-method + +|void| **set_axis_x_enabled**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制 X 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_x_inverted: + +.. rst-class:: classref-method + +|void| **set_axis_x_inverted**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会翻转 X 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_y_enabled: + +.. rst-class:: classref-method + +|void| **set_axis_y_enabled**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制 Y 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_y_inverted: + +.. rst-class:: classref-method + +|void| **set_axis_y_inverted**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会翻转 Y 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_z_enabled: + +.. rst-class:: classref-method + +|void| **set_axis_z_enabled**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制 Z 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_axis_z_inverted: + +.. rst-class:: classref-method + +|void| **set_axis_z_inverted**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会翻转 Z 轴。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_copy_flags: + +.. rst-class:: classref-method + +|void| **set_copy_flags**\ (\ index\: :ref:`int`, copy_flags\: |bitfield|\[:ref:`TransformFlag`\]\ ) :ref:`🔗` + +设置处理变换操作的标志。如果标志有效，则会处理变换操作。 + +\ **注意：**\ 如果旋转仅对一个轴有效，就会考虑有效轴的滚转值。如果旋转对两个轴有效，就会丢弃无效轴的滚转值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_copy_position: + +.. rst-class:: classref-method + +|void| **set_copy_position**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_copy_rotation: + +.. rst-class:: classref-method + +|void| **set_copy_rotation**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制旋转。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_copy_scale: + +.. rst-class:: classref-method + +|void| **set_copy_scale**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则会复制缩放。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_invert_flags: + +.. rst-class:: classref-method + +|void| **set_invert_flags**\ (\ index\: :ref:`int`, axis_flags\: |bitfield|\[:ref:`AxisFlag`\]\ ) :ref:`🔗` + +设置翻转轴的标志。如果标志有效，则会复制该轴。 + +\ **注意：**\ 缩放翻转意味着对数值取倒数，并不是负数缩放。例如将 ``2.0`` 翻转就是 ``0.5``\ 。 + +\ **注意：**\ 旋转翻转会翻转四元数的元素。例如，双轴反转会翻转每个轴的滚转，而三轴反转会翻转最终朝向。不过请注意，仅翻转一个轴可能会导致未翻转轴的意外旋转，这是由于四元数的特性所导致的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_CopyTransformModifier3D_method_set_relative: + +.. rst-class:: classref-method + +|void| **set_relative**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +将索引为 ``index`` 的设置的相对选项设置为 ``enabled``\ 。 + +如果将 ``enabled`` 设置为 ``true``\ ，则提取并应用的变换是相对于放松姿势的。 + +如果将 ``enabled`` 设置为 ``false``\ ，则提取到的变换是绝对的。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_cpuparticles2d.rst b/classes/zh_CN/class_cpuparticles2d.rst index 6b55fa948d..43a8f83bae 100644 --- a/classes/zh_CN/class_cpuparticles2d.rst +++ b/classes/zh_CN/class_cpuparticles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CPUParticles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CPUParticles2D.xml. .. _class_CPUParticles2D: @@ -840,7 +840,7 @@ enum **EmissionShape**: :ref:`🔗` - |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) - :ref:`DrawOrder` **get_draw_order**\ (\ ) -粒子绘制顺序。使用 :ref:`DrawOrder` 的值。 +粒子绘制顺序。 .. rst-class:: classref-item-separator @@ -931,7 +931,7 @@ enum **EmissionShape**: :ref:`🔗` - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) - :ref:`EmissionShape` **get_emission_shape**\ (\ ) -粒子将在此区域内发射。可能的取值见 :ref:`EmissionShape`\ 。 +粒子将在该区域内发射。 .. rst-class:: classref-item-separator @@ -1697,7 +1697,7 @@ enum **EmissionShape**: :ref:`🔗` :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` -返回给定粒子标志的启用状态（选项见 :ref:`ParticleFlags`\ ）。 +返回给定粒子标志的启用状态。 .. rst-class:: classref-item-separator @@ -1773,9 +1773,10 @@ enum **EmissionShape**: :ref:`🔗` |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` -启用或禁用给定的标志（选项见 :ref:`ParticleFlags`\ ）。 +启用或禁用给定的粒子标志。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cpuparticles3d.rst b/classes/zh_CN/class_cpuparticles3d.rst index 6c39d7b9b9..2e18454050 100644 --- a/classes/zh_CN/class_cpuparticles3d.rst +++ b/classes/zh_CN/class_cpuparticles3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CPUParticles3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CPUParticles3D.xml. .. _class_CPUParticles3D: @@ -880,7 +880,7 @@ enum **EmissionShape**: :ref:`🔗` - |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) - :ref:`DrawOrder` **get_draw_order**\ (\ ) -粒子绘制顺序。使用 :ref:`DrawOrder` 的值。 +粒子绘制顺序。 .. rst-class:: classref-item-separator @@ -1060,7 +1060,7 @@ enum **EmissionShape**: :ref:`🔗` - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) - :ref:`EmissionShape` **get_emission_shape**\ (\ ) -粒子将在此区域内发射。可能的取值见 :ref:`EmissionShape`\ 。 +粒子将在该区域内发射。 .. rst-class:: classref-item-separator @@ -1921,7 +1921,7 @@ Y/Z 平面中的 :ref:`spread` 数量。 :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` -返回给定粒子标志的启用状态（选项见 :ref:`ParticleFlags`\ ）。 +返回给定粒子标志的启用状态。 .. rst-class:: classref-item-separator @@ -1997,9 +1997,10 @@ Y/Z 平面中的 :ref:`spread` 数量。 |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` -启用或禁用给定的粒子标志（选项见 :ref:`ParticleFlags`\ ）。 +启用或禁用给定的粒子标志。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_crypto.rst b/classes/zh_CN/class_crypto.rst index f6a134100a..62c49bce49 100644 --- a/classes/zh_CN/class_crypto.rst +++ b/classes/zh_CN/class_crypto.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Crypto.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Crypto.xml. .. _class_Crypto: @@ -29,30 +29,30 @@ Crypto 类提供对高阶加密功能的访问。 .. code-tab:: gdscript var crypto = Crypto.new() - + # 生成新的 RSA 密钥。 var key = crypto.generate_rsa(4096) - + # 使用给定的密钥生成新的自签名证书。 var cert = crypto.generate_self_signed_certificate(key, "CN=mydomain.com,O=My Game Company,C=IT") - + # 将密钥和证书保存在用户文件夹中。 key.save("user://generated.key") cert.save("user://generated.crt") - + # 加密 var data = "Some data" var encrypted = crypto.encrypt(key, data.to_utf8_buffer()) - + # 解密 var decrypted = crypto.decrypt(key, encrypted) - + # 签名 var signature = crypto.sign(HashingContext.HASH_SHA256, data.sha256_buffer(), key) - + # 验证 var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key) - + # 校验 assert(verified) assert(data.to_utf8_buffer() == decrypted) @@ -61,32 +61,32 @@ Crypto 类提供对高阶加密功能的访问。 using Godot; using System.Diagnostics; - + Crypto crypto = new Crypto(); - + // 生成新的 RSA 密钥。 CryptoKey key = crypto.GenerateRsa(4096); - + // 使用给定的密钥生成新的自签名证书。 X509Certificate cert = crypto.GenerateSelfSignedCertificate(key, "CN=mydomain.com,O=My Game Company,C=IT"); - + // 将密钥和证书保存在用户文件夹中。 key.Save("user://generated.key"); cert.Save("user://generated.crt"); - + // 加密 string data = "Some data"; byte[] encrypted = crypto.Encrypt(key, data.ToUtf8Buffer()); - + // 解密 byte[] decrypted = crypto.Decrypt(key, encrypted); - + // 签名 byte[] signature = crypto.Sign(HashingContext.HashType.Sha256, Data.Sha256Buffer(), key); - + // 验证 bool verified = crypto.Verify(HashingContext.HashType.Sha256, Data.Sha256Buffer(), signature, key); - + // 校验 Debug.Assert(verified); Debug.Assert(data.ToUtf8Buffer() == decrypted); @@ -266,6 +266,7 @@ Crypto 类提供对高阶加密功能的访问。 使用提供的公钥 ``key`` 验证类型为 ``hash_type`` 的给定签名 ``signature``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cryptokey.rst b/classes/zh_CN/class_cryptokey.rst index 0f15679ec6..c7278c6277 100644 --- a/classes/zh_CN/class_cryptokey.rst +++ b/classes/zh_CN/class_cryptokey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CryptoKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CryptoKey.xml. .. _class_CryptoKey: @@ -120,6 +120,7 @@ CryptoKey 类表示加密密钥。密钥可以像其他任何 :ref:`Resource` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgcylinder3d.rst b/classes/zh_CN/class_csgcylinder3d.rst index 289e742f8a..b2a6bfe412 100644 --- a/classes/zh_CN/class_csgcylinder3d.rst +++ b/classes/zh_CN/class_csgcylinder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGCylinder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGCylinder3D.xml. .. _class_CSGCylinder3D: @@ -160,6 +160,7 @@ CSG 圆柱形状。 如果为 ``true``\ ，则将圆柱体的法线设置为具有平滑效果，使圆柱体看起来是圆形的。如果为 ``false``\ ，则圆柱体将具有平坦的阴影表现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgmesh3d.rst b/classes/zh_CN/class_csgmesh3d.rst index 3090527050..029b350024 100644 --- a/classes/zh_CN/class_csgmesh3d.rst +++ b/classes/zh_CN/class_csgmesh3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGMesh3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGMesh3D.xml. .. _class_CSGMesh3D: @@ -90,6 +90,7 @@ CSGMesh3D \ :ref:`Mesh.ARRAY_NORMAL` 仅被用于确定哪些面需要使用平直着色。默认情况下，CSGMesh 将忽略该网格的顶点法线，为每个顶点重新计算它们并使用一个平滑着色器。如果面需要平直着色器，请确保面的所有顶点法线大致相等。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgpolygon3d.rst b/classes/zh_CN/class_csgpolygon3d.rst index 0997bf6a8f..06b4dc7778 100644 --- a/classes/zh_CN/class_csgpolygon3d.rst +++ b/classes/zh_CN/class_csgpolygon3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGPolygon3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGPolygon3D.xml. .. _class_CSGPolygon3D: @@ -476,6 +476,7 @@ enum **PathIntervalType**: :ref:`🔗` :ref:`mode` 为 :ref:`MODE_SPIN` 时，挤出的次数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgprimitive3d.rst b/classes/zh_CN/class_csgprimitive3d.rst index 382e4026d4..ccd0f36746 100644 --- a/classes/zh_CN/class_csgprimitive3d.rst +++ b/classes/zh_CN/class_csgprimitive3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGPrimitive3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGPrimitive3D.xml. .. _class_CSGPrimitive3D: @@ -67,6 +67,7 @@ CSG 图元的基类。 如果设置，则每个三角形中顶点的顺序会颠倒，从而导致绘制网格的背面。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgshape3d.rst b/classes/zh_CN/class_csgshape3d.rst index 9418b48862..be7f4706d8 100644 --- a/classes/zh_CN/class_csgshape3d.rst +++ b/classes/zh_CN/class_csgshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGShape3D.xml. .. _class_CSGShape3D: @@ -23,15 +23,13 @@ CSG 基类。 这是 CSG 的基类，为 Godot 中的各种 CSG 节点提供 CSG 运算支持。 -\ **性能：**\ CSG 节点仅适用于原型设计，存在显著的 CPU 性能消耗。 - -请考虑将最终的 CSG 运算结果烘焙为静态几何体，替换 CSG 节点。 +\ **性能：**\ CSG 节点仅适用于原型设计，存在显著的 CPU 性能消耗。请考虑将最终的 CSG 运算结果烘焙为静态几何体，替换 CSG 节点。 使用选中 CSG 根节点后显示的编辑器菜单可以将各个 CSG 根节点的结果烘焙为使用静态资源的节点。 使用脚本也可以将各个 CSG 根节点烘焙为静态资源，可视网格请调用 :ref:`bake_static_mesh()`\ ，物理碰撞请调用 :ref:`bake_collision_shape()`\ 。 -使用编辑器的 gltf 场景导出器可以将由 CSG 节点构成的整个场景烘焙为静态几何体。 +使用编辑器的 gltf 场景导出器可以将由 CSG 节点构成的整个场景烘焙为静态几何体：\ **场景 > 导出为... > glTF 2.0 场景...** .. rst-class:: classref-introduction-group @@ -149,7 +147,7 @@ enum **Operation**: :ref:`🔗` - |void| **set_calculate_tangents**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_calculating_tangents**\ (\ ) -计算允许使用法线贴图的 CSG 形状的切线。这仅适用于根部形状，此设置将在所有子级上均被忽略。 +计算允许使用法线贴图的 CSG 形状的切线。仅适用于根形状，该设置在所有子级上均被忽略。设置为 ``false`` 可以略微加速形状的生成。 .. rst-class:: classref-item-separator @@ -278,6 +276,8 @@ enum **Operation**: :ref:`🔗` \ **性能：**\ 如果 CSG 运算得到的是包含大量细节的几何体，面数很多，那么物理性能可能非常慢。一般来说，凹面形状应该只用来制作静态关卡几何体，不应用来制作可以移动的动态物体。 +\ **注意：**\ CSG 网格数据是延迟更新的，即延迟一个渲染帧后更新。为了避免获取到空形状或过时的网格数据，请确保在 :ref:`Node._ready()` 中使用 :ref:`bake_collision_shape()` 之前，或在更改 **CSGShape3D** 的属性后，调用 ``await get_tree().process_frame``\ 。 + .. rst-class:: classref-item-separator ---- @@ -288,7 +288,9 @@ enum **Operation**: :ref:`🔗` :ref:`ArrayMesh` **bake_static_mesh**\ (\ ) :ref:`🔗` -返回将该节点 CSG 运算的结果烘焙得到的静态 :ref:`ArrayMesh`\ 。复杂 CSG 节点的材质会添加为额外的网格表面。如果该节点不是 CSG 根节点或没有有效的几何体，则返回空网格。 +返回该节点 CSG 运算结果烘焙得到的静态 :ref:`ArrayMesh`\ 。相关 CSG 节点的材质会作为额外的网格表面添加。如果该节点不是 CSG 根节点或没有有效的几何体，则返回空网格。 + +\ **注意：**\ CSG 网格数据是延迟更新的，存在一个渲染帧的更新延迟。要避免获取到空的形状或过时的网格数据，请确保在 :ref:`Node._ready()` 中使用 :ref:`get_meshes()` 之前以及在修改 **CSGShape3D** 的属性后调用 ``await get_tree().process_frame``\ 。 .. rst-class:: classref-item-separator @@ -324,7 +326,9 @@ enum **Operation**: :ref:`🔗` :ref:`Array` **get_meshes**\ (\ ) |const| :ref:`🔗` -返回一个包含两个元素的 :ref:`Array`\ ，第一个元素是该节点的 :ref:`Transform3D`\ ，第二个元素是该节点的根 :ref:`Mesh`\ 。仅当该节点是根形状时才有效。 +返回一个包含两个元素的 :ref:`Array`\ ，第一个元素是该节点的 :ref:`Transform3D`\ ，第二个元素是该节点的根 :ref:`Mesh`\ 。仅在该节点为根形状时有效。 + +\ **注意：**\ CSG 网格数据是延迟更新的，存在一个渲染帧的更新延迟。要避免获取到空的形状或过时的网格数据，请确保在 :ref:`Node._ready()` 中使用 :ref:`get_meshes()` 之前以及在修改 **CSGShape3D** 的属性后调用 ``await get_tree().process_frame``\ 。 .. rst-class:: classref-item-separator @@ -363,6 +367,7 @@ enum **Operation**: :ref:`🔗` 根据 ``value``\ ，启用或禁用 :ref:`collision_mask` 中指定的层，给定的 ``layer_number`` 应在 1 和 32 之间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgsphere3d.rst b/classes/zh_CN/class_csgsphere3d.rst index 59c7ffae0f..4b8056df34 100644 --- a/classes/zh_CN/class_csgsphere3d.rst +++ b/classes/zh_CN/class_csgsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGSphere3D.xml. .. _class_CSGSphere3D: @@ -141,6 +141,7 @@ CSG 球形形状。 如果为 ``true``\ ，则将球体的法线设置为具有平滑效果，使球体看起来是圆形的。如果为 ``false``\ ，则球体将具有平坦的阴影表现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csgtorus3d.rst b/classes/zh_CN/class_csgtorus3d.rst index 5893f5760a..a41168a012 100644 --- a/classes/zh_CN/class_csgtorus3d.rst +++ b/classes/zh_CN/class_csgtorus3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/csg/doc_classes/CSGTorus3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGTorus3D.xml. .. _class_CSGTorus3D: @@ -160,6 +160,7 @@ CSG 圆环形状。 如果 ``true`` 设置圆环的法线以提供平滑效果，则使圆环看起来是圆形的。如果为 ``false``\ ，则圆环将具有平坦的阴影表现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_csharpscript.rst b/classes/zh_CN/class_csharpscript.rst index a1f46f0b34..3c6044f3c5 100644 --- a/classes/zh_CN/class_csharpscript.rst +++ b/classes/zh_CN/class_csharpscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/mono/doc_classes/CSharpScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/mono/doc_classes/CSharpScript.xml. .. _class_CSharpScript: @@ -58,6 +58,7 @@ This class represents a C# script. It is the C# equivalent of the :ref:`GDScript Returns a new instance of the script. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cubemap.rst b/classes/zh_CN/class_cubemap.rst index f135107875..d8b028d9e4 100644 --- a/classes/zh_CN/class_cubemap.rst +++ b/classes/zh_CN/class_cubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Cubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Cubemap.xml. .. _class_Cubemap: @@ -40,10 +40,10 @@ Cubemap .. code:: text shader_type sky; - + uniform samplerCube source_panorama : filter_linear, source_color, hint_default_black; uniform float exposure : hint_range(0, 128) = 1.0; - + void sky() { // 如果立方体贴图是从其他引擎导入的，可能需要通过将下面的 // 某一个 `EYEDIR` 分量替换为 `-EYEDIR` 来进行翻转。 @@ -85,6 +85,7 @@ Cubemap 创建该资源的占位符版本（\ :ref:`PlaceholderCubemap`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cubemaparray.rst b/classes/zh_CN/class_cubemaparray.rst index 9a5a743c6a..acf2ed18b8 100644 --- a/classes/zh_CN/class_cubemaparray.rst +++ b/classes/zh_CN/class_cubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CubemapArray.xml. .. _class_CubemapArray: @@ -71,6 +71,7 @@ Godot 内部使用 **CubemapArray** 来实现许多效果，例如将 :ref:`Proj 创建该资源的占位符版本（\ :ref:`PlaceholderCubemapArray`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_curve.rst b/classes/zh_CN/class_curve.rst index 462068453a..fdfd68a9e0 100644 --- a/classes/zh_CN/class_curve.rst +++ b/classes/zh_CN/class_curve.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Curve.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve.xml. .. _class_Curve: @@ -516,6 +516,7 @@ enum **TangentMode**: :ref:`🔗` 将索引为 ``index`` 的点的垂直位置设置为 ``y``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_curve2d.rst b/classes/zh_CN/class_curve2d.rst index 9ae7dbd82e..4dde24ac44 100644 --- a/classes/zh_CN/class_curve2d.rst +++ b/classes/zh_CN/class_curve2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Curve2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve2D.xml. .. _class_Curve2D: @@ -387,6 +387,7 @@ Curve2D \ ``tolerance_length`` 控制在必须细分线段之前两个相邻点之间的最大距离。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_curve3d.rst b/classes/zh_CN/class_curve3d.rst index cf613a5ce0..07dc577ef3 100644 --- a/classes/zh_CN/class_curve3d.rst +++ b/classes/zh_CN/class_curve3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Curve3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve3D.xml. .. _class_Curve3D: @@ -490,6 +490,7 @@ Curve3D \ ``tolerance_length`` 控制在必须细分线段之前两个相邻点之间的最大距离。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_curvetexture.rst b/classes/zh_CN/class_curvetexture.rst index 46a99c01ab..3e85565126 100644 --- a/classes/zh_CN/class_curvetexture.rst +++ b/classes/zh_CN/class_curvetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CurveTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CurveTexture.xml. .. _class_CurveTexture: @@ -129,6 +129,7 @@ enum **TextureMode**: :ref:`🔗` 纹理宽度（单位为像素）。较大的值能够更好地表示高频数据（例如方向的突变），但会增加生成时间和内存占用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_curvexyztexture.rst b/classes/zh_CN/class_curvexyztexture.rst index 6c4f6723b7..3d47157d0b 100644 --- a/classes/zh_CN/class_curvexyztexture.rst +++ b/classes/zh_CN/class_curvexyztexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CurveXYZTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CurveXYZTexture.xml. .. _class_CurveXYZTexture: @@ -117,6 +117,7 @@ CurveXYZTexture 纹理宽度（单位为像素）。较大的值能够更好地表示高频数据（例如方向的突变），但会增加生成时间和内存占用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cylindermesh.rst b/classes/zh_CN/class_cylindermesh.rst index 361c23f86c..79724e6edb 100644 --- a/classes/zh_CN/class_cylindermesh.rst +++ b/classes/zh_CN/class_cylindermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CylinderMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CylinderMesh.xml. .. _class_CylinderMesh: @@ -174,6 +174,7 @@ CylinderMesh 圆柱体的顶部半径。如果设置为 ``0.0``\ ，则不会生成顶面，呈圆锥状。另见 :ref:`cap_top`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_cylindershape3d.rst b/classes/zh_CN/class_cylindershape3d.rst index db71eba1d3..d90b3241ac 100644 --- a/classes/zh_CN/class_cylindershape3d.rst +++ b/classes/zh_CN/class_cylindershape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/CylinderShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CylinderShape3D.xml. .. _class_CylinderShape3D: @@ -90,6 +90,7 @@ CylinderShape3D 圆柱体的半径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_dampedspringjoint2d.rst b/classes/zh_CN/class_dampedspringjoint2d.rst index 478b15cf79..ea2b0ad53a 100644 --- a/classes/zh_CN/class_dampedspringjoint2d.rst +++ b/classes/zh_CN/class_dampedspringjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DampedSpringJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DampedSpringJoint2D.xml. .. _class_DampedSpringJoint2D: @@ -19,7 +19,7 @@ DampedSpringJoint2D 描述 ---- -通过类似弹簧的力连接两个 2D 物理物体的物理关节。这就像一个总是想拉伸到给定长度的弹簧。 +通过类似弹簧的力连接两个 2D 物理物体的物理关节。这表现得像一个总是想拉伸到给定长度的弹簧。 .. rst-class:: classref-reftable-group @@ -113,6 +113,7 @@ DampedSpringJoint2D 该值越大，连接在关节上的机构变形越小。关节对各机构施加一个相反的力，即刚度乘以与其静止长度的大小差的乘积。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_decal.rst b/classes/zh_CN/class_decal.rst index 75307afbb6..5fbe093dec 100644 --- a/classes/zh_CN/class_decal.rst +++ b/classes/zh_CN/class_decal.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Decal.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Decal.xml. .. _class_Decal: @@ -491,6 +491,7 @@ enum **DecalTexture**: :ref:`🔗` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_dictionary.rst b/classes/zh_CN/class_dictionary.rst index 3031fff3a3..a0d22248ce 100644 --- a/classes/zh_CN/class_dictionary.rst +++ b/classes/zh_CN/class_dictionary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Dictionary.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Dictionary.xml. .. _class_Dictionary: @@ -29,16 +29,16 @@ Dictionary .. code-tab:: gdscript var my_dict = {} # 创建空字典。 - + var dict_variable_key = "Another key name" var dict_variable_value = "value2" var another_dict = { "Some key name": "value1", dict_variable_key: dict_variable_value, } - - var points_dict = {"White": 50, "Yellow": 75, "Orange": 100} - + + var points_dict = { "White": 50, "Yellow": 75, "Orange": 100 } + # 备选 Lua 分隔语法。 # 不需要在键周围加引号，但键名只能为字符串常量。 # 另外，键名必须以字母或下划线开头。 @@ -52,9 +52,9 @@ Dictionary var myDict = new Godot.Collections.Dictionary(); // 创建空字典。 var pointsDict = new Godot.Collections.Dictionary { - {"White", 50}, - {"Yellow", 75}, - {"Orange", 100} + { "White", 50 }, + { "Yellow", 75 }, + { "Orange", 100 }, }; @@ -67,7 +67,7 @@ Dictionary .. code-tab:: gdscript @export_enum("White", "Yellow", "Orange") var my_color: String - var points_dict = {"White": 50, "Yellow": 75, "Orange": 100} + var points_dict = { "White": 50, "Yellow": 75, "Orange": 100 } func _ready(): # 不能使用点语法，因为 `my_color` 是变量。 var points = points_dict[my_color] @@ -78,11 +78,11 @@ Dictionary public string MyColor { get; set; } private Godot.Collections.Dictionary _pointsDict = new Godot.Collections.Dictionary { - {"White", 50}, - {"Yellow", 75}, - {"Orange", 100} + { "White", 50 }, + { "Yellow", 75 }, + { "Orange", 100 }, }; - + public override void _Ready() { int points = (int)_pointsDict[MyColor]; @@ -107,7 +107,7 @@ Dictionary var myDict = new Godot.Collections.Dictionary { - {"First Array", new Godot.Collections.Array{1, 2, 3, 4}} + { "First Array", new Godot.Collections.Array { 1, 2, 3, 4 } } }; @@ -119,16 +119,16 @@ Dictionary .. code-tab:: gdscript - var points_dict = {"White": 50, "Yellow": 75, "Orange": 100} + var points_dict = { "White": 50, "Yellow": 75, "Orange": 100 } points_dict["Blue"] = 150 # 将 "Blue" 添加为键，并将 150 赋为它的值。 .. code-tab:: csharp var pointsDict = new Godot.Collections.Dictionary { - {"White", 50}, - {"Yellow", 75}, - {"Orange", 100} + { "White", 50 }, + { "Yellow", 75 }, + { "Orange", 100 }, }; pointsDict["Blue"] = 150; // 将 "Blue" 添加为键，并将 150 赋为它的值。 @@ -148,7 +148,7 @@ Dictionary "String Key": 5, 4: [1, 2, 3], 7: "Hello", - "sub_dict": {"sub_key": "Nested value"}, + "sub_dict": { "sub_key": "Nested value" }, } .. code-tab:: csharp @@ -156,10 +156,10 @@ Dictionary // 这是有效的字典。 // 要访问下面的 "Nested value"，请使用 `((Godot.Collections.Dictionary)myDict["sub_dict"])["sub_key"]`。 var myDict = new Godot.Collections.Dictionary { - {"String Key", 5}, - {4, new Godot.Collections.Array{1,2,3}}, - {7, "Hello"}, - {"sub_dict", new Godot.Collections.Dictionary{{"sub_key", "Nested value"}}} + { "String Key", 5 }, + { 4, new Godot.Collections.Array { 1, 2, 3 } }, + { 7, "Hello" }, + { "sub_dict", new Godot.Collections.Dictionary { { "sub_key", "Nested value" } } }, }; @@ -171,13 +171,13 @@ Dictionary .. code-tab:: gdscript - var groceries = {"Orange": 20, "Apple": 2, "Banana": 4} + var groceries = { "Orange": 20, "Apple": 2, "Banana": 4 } for fruit in groceries: var amount = groceries[fruit] .. code-tab:: csharp - var groceries = new Godot.Collections.Dictionary{{"Orange", 20}, {"Apple", 2}, {"Banana", 4}}; + var groceries = new Godot.Collections.Dictionary { { "Orange", 20 }, { "Apple", 2 }, { "Banana", 4 } }; foreach (var (fruit, amount) in groceries) { // `fruit` 为键，`amount` 为值。 @@ -235,6 +235,8 @@ Dictionary +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`duplicate_deep`\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`erase`\ (\ key\: :ref:`Variant`\ ) | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`find_key`\ (\ value\: :ref:`Variant`\ ) |const| | @@ -388,7 +390,25 @@ Dictionary :ref:`Dictionary` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| :ref:`🔗` -创建并返回该字典的副本。如果 ``deep`` 为 ``true``\ ，内部的 **Dictionary** 和 :ref:`Array` 键和值也会被递归复制。 +返回字典的新副本。 + +默认情况下返回的是\ **浅拷贝**\ ：嵌套的 :ref:`Array`\ 、\ **Dictionary** 和 :ref:`Resource` 键和值与原字典共享。对这些键和值的修改会影响另一个字典。 + +如果 ``deep`` 为 ``true`` 则会返回\ **深拷贝**\ ：嵌套的数组和字典也会进行（递归的）复制。不过 :ref:`Resource` 仍然是和原字典共享的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Dictionary_method_duplicate_deep: + +.. rst-class:: classref-method + +:ref:`Dictionary` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| :ref:`🔗` + +深度复制该字典，类似 :ref:`duplicate()`\ ``(true)``\ ，但能够额外控制子资源的处理方式。 + +\ ``deep_subresources_mode`` 必须是 :ref:`DeepDuplicateMode` 中的一个值。默认只会（递归）复制内部资源。 .. rst-class:: classref-item-separator @@ -535,7 +555,7 @@ Dictionary "Godot" : 4, 210 : null, } - + print(my_dict.has("Godot")) # 输出 true print(my_dict.has(210)) # 输出 true print(my_dict.has(4)) # 输出 false @@ -547,7 +567,7 @@ Dictionary { "Godot", 4 }, { 210, default }, }; - + GD.Print(myDict.ContainsKey("Godot")); // 输出 True GD.Print(myDict.ContainsKey(210)); // 输出 True GD.Print(myDict.ContainsKey(4)); // 输出 False @@ -558,7 +578,7 @@ Dictionary :: - if "Godot" in {"Godot": 4}: + if "Godot" in { "Godot": 4 }: print("这个键存在！") # 会进行输出。 \ **注意：**\ 只要键 ``key`` 存在，该方法就会返回 ``true``\ ，即便这个键对应的值为 ``null``\ 。 @@ -577,7 +597,7 @@ Dictionary :: - var data = {"width" : 10, "height" : 20} + var data = { "width": 10, "height": 20 } data.has_all(["height", "width"]) # 返回 true .. rst-class:: classref-item-separator @@ -597,16 +617,16 @@ Dictionary .. code-tab:: gdscript - var dict1 = {"A": 10, "B": 2} - var dict2 = {"A": 10, "B": 2} - + var dict1 = { "A": 10, "B": 2 } + var dict2 = { "A": 10, "B": 2 } + print(dict1.hash() == dict2.hash()) # 输出 true .. code-tab:: csharp - var dict1 = new Godot.Collections.Dictionary{{"A", 10}, {"B", 2}}; - var dict2 = new Godot.Collections.Dictionary{{"A", 10}, {"B", 2}}; - + var dict1 = new Godot.Collections.Dictionary { { "A", 10 }, { "B", 2 } }; + var dict2 = new Godot.Collections.Dictionary { { "A", 10 }, { "B", 2 } }; + // Godot.Collections.Dictionary 没有 Hash() 方法。请改用 GD.Hash()。 GD.Print(GD.Hash(dict1) == GD.Hash(dict2)); // 输出 True @@ -755,11 +775,11 @@ Dictionary var dict = { "item": "sword", "quantity": 2 } var other_dict = { "quantity": 15, "color": "silver" } - + # 默认情况下禁用覆盖已有键。 dict.merge(other_dict) print(dict) # { "item": "sword", "quantity": 2, "color": "silver" } - + # 启用覆盖已有键。 dict.merge(other_dict, true) print(dict) # { "item": "sword", "quantity": 15, "color": "silver" } @@ -771,17 +791,17 @@ Dictionary ["item"] = "sword", ["quantity"] = 2, }; - + var otherDict = new Godot.Collections.Dictionary { ["quantity"] = 15, ["color"] = "silver", }; - + // 默认情况下禁用覆盖已有键。 dict.Merge(otherDict); GD.Print(dict); // { "item": "sword", "quantity": 2, "color": "silver" } - + // 启用覆盖已有键。 dict.Merge(otherDict, true); GD.Print(dict); // { "item": "sword", "quantity": 15, "color": "silver" } @@ -859,7 +879,20 @@ Dictionary |void| **sort**\ (\ ) :ref:`🔗` -将字典按照键的顺序原地排序。可以确保具有相同内容的字典在获取 :ref:`keys()`\ 、获取 :ref:`values()` 和转换为字符串时得到相同的结果。适用于希望 JSON 表示与内存中一致的场合，也适用于需要字典有序的数据库存储的场合。 +将字典中的键按升序排列。最终的顺序取决于键与键之间的“小于”比较（\ ``<``\ ）。 + + +.. tabs:: + + .. code-tab:: gdscript + + var numbers = { "c": 2, "a": 0, "b": 1 } + numbers.sort() + print(numbers) # Prints { "a": 0, "b": 1, "c": 2 } + + + +该方法能够确保字典中条目顺序的一致性，适用于调用 :ref:`keys()` 或 :ref:`values()` 的情况，以及通过 :ref:`@GlobalScope.str()` 或 :ref:`JSON.stringify()` 将字典转换为字符串的情况。 .. rst-class:: classref-item-separator @@ -917,6 +950,7 @@ Dictionary 返回该字典中与给定的键 ``key`` 对应的值。如果条目不存在，失败并返回 ``null``\ 。为了更安全的访问，请使用 :ref:`get()` 或 :ref:`has()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_diraccess.rst b/classes/zh_CN/class_diraccess.rst index e2a417af9b..fbd683217c 100644 --- a/classes/zh_CN/class_diraccess.rst +++ b/classes/zh_CN/class_diraccess.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DirAccess.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirAccess.xml. .. _class_DirAccess: @@ -155,6 +155,8 @@ DirAccess +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_files_at`\ (\ path\: :ref:`String`\ ) |static| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_filesystem_type`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_next`\ (\ ) | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`get_open_error`\ (\ ) |static| | @@ -165,6 +167,8 @@ DirAccess +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_case_sensitive`\ (\ path\: :ref:`String`\ ) |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equivalent`\ (\ path_a\: :ref:`String`, path_b\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_link`\ (\ path\: :ref:`String`\ ) | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`list_dir_begin`\ (\ ) | @@ -440,13 +444,13 @@ DirAccess :ref:`int` **get_drive_count**\ (\ ) |static| :ref:`🔗` -在 Windows 上，返回挂载在当前文件系统上的驱动器（分区）数量。 +On Windows, returns the number of drives (partitions) mounted on the current filesystem. -在 macOS 上，返回挂载卷的数量。 +On macOS and Android, returns the number of mounted volumes. -在 Linux 上，返回挂载卷与 GTK 3 书签的数量。 +On Linux, returns the number of mounted volumes and GTK 3 bookmarks. -在其他平台上，该方法返回 0。 +On other platforms, the method returns 0. .. rst-class:: classref-item-separator @@ -458,13 +462,15 @@ DirAccess :ref:`String` **get_drive_name**\ (\ idx\: :ref:`int`\ ) |static| :ref:`🔗` -在 Windows 上，返回作为参数传递的驱动器（分区）的名称（例如 ``C:``\ ）。 +On Windows, returns the name of the drive (partition) passed as an argument (e.g. ``C:``). -在 macOS 上，返回作为参数传递的挂载卷的路径。 +On macOS, returns the path to the mounted volume passed as an argument. -在 Linux 上，返回作为参数传递的挂载卷或 GTK 3 书签的路径。 +On Linux, returns the path to the mounted volume or GTK 3 bookmark passed as an argument. -在其他平台上，或者当请求的驱动器不存在时，该方法会返回空的 String。 +On Android (API level 30+), returns the path to the mounted volume as an argument. + +On other platforms, or if the requested drive does not exist, the method returns an empty String. .. rst-class:: classref-item-separator @@ -502,6 +508,20 @@ DirAccess ---- +.. _class_DirAccess_method_get_filesystem_type: + +.. rst-class:: classref-method + +:ref:`String` **get_filesystem_type**\ (\ ) |const| :ref:`🔗` + +返回当前目录所在磁盘的文件系统类型名称。返回的值是大写字符串，如 ``NTFS``\ 、\ ``FAT32``\ 、\ ``EXFAT``\ 、\ ``APFS``\ 、\ ``EXT4``\ 、\ ``BTRFS`` 等。 + +\ **注意：**\ 该方法在 macOS、Linux、Windows 以及 PCK 虚拟文件系统上实现。 + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_get_next: .. rst-class:: classref-method @@ -568,6 +588,18 @@ DirAccess ---- +.. _class_DirAccess_method_is_equivalent: + +.. rst-class:: classref-method + +:ref:`bool` **is_equivalent**\ (\ path_a\: :ref:`String`, path_b\: :ref:`String`\ ) |const| :ref:`🔗` + +如果路径 ``path_a`` 和路径 ``path_b`` 解析为同一个文件系统对象则返回 ``true``\ 。否则返回 ``false``\ ，即使这两个文件的内容完全相同（例如，两个相同的文件副本，但不是符号链接）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_is_link: .. rst-class:: classref-method @@ -741,6 +773,7 @@ DirAccess 静态版本的 :ref:`rename()`\ 。仅支持绝对路径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_directionallight2d.rst b/classes/zh_CN/class_directionallight2d.rst index 92361a8d78..00328b55e4 100644 --- a/classes/zh_CN/class_directionallight2d.rst +++ b/classes/zh_CN/class_directionallight2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DirectionalLight2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirectionalLight2D.xml. .. _class_DirectionalLight2D: @@ -24,6 +24,8 @@ DirectionalLight2D 平行光是一种 :ref:`Light2D` 节点，模拟覆盖整个场景的无数平行光线。可用于远离场景的强光（例如：模拟日光或月光）。 +光线沿节点全局基的 +Y 方向发射。对于未旋转的灯光，这意味着光线向下发射。节点的位置会被忽略；只有基被用于确定光线方向 + \ **注意：**\ **DirectionalLight2D** 不支持灯光剔除遮罩（但支持阴影剔除遮罩）。它会忽略 2D 节点的 :ref:`CanvasItem.light_mask`\ ，始终点亮 2D 节点。 .. rst-class:: classref-introduction-group @@ -87,6 +89,7 @@ DirectionalLight2D 对象在其阴影被剔除前与相机中心的最大距离（单位：像素）。降低这个值可以防止位于相机外部的对象投射阴影（同时还可以提高性能）。\ :ref:`Camera2D.zoom` 不被 :ref:`max_distance` 考虑在内，这意味着在较高的缩放值下，当缩放到一个给定的点时，阴影会更快地淡出。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_directionallight3d.rst b/classes/zh_CN/class_directionallight3d.rst index 4dc62cb99c..5b5b1bcf4b 100644 --- a/classes/zh_CN/class_directionallight3d.rst +++ b/classes/zh_CN/class_directionallight3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DirectionalLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirectionalLight3D.xml. .. _class_DirectionalLight3D: @@ -22,7 +22,9 @@ DirectionalLight3D 描述 ---- -平行光是一种 :ref:`Light3D` 节点，它可以模拟覆盖整个场景的无限数量的平行光线。它用于距离场景较远的强光，以模拟日光或月光。 DirectionalLight3D 变换的世界空间位置（原点）将被忽略。只有基被用于确定光线方向。 +平行光是一种 :ref:`Light3D` 节点，它可以模拟覆盖整个场景的无限数量的平行光线。它用于距离场景较远的强光，以模拟日光或月光。 + +光线沿节点全局基的 -Z 方向发射。对于未旋转的光源，这意味着光线向前发射，照亮 3D 模型的正面（参见 :ref:`Vector3.FORWARD` 和 :ref:`Vector3.MODEL_FRONT`\ ）。节点的位置会被忽略；只有基被用于确定光线方向。 .. rst-class:: classref-introduction-group @@ -205,7 +207,7 @@ enum **SkyMode**: :ref:`🔗` - |void| **set_shadow_mode**\ (\ value\: :ref:`ShadowMode`\ ) - :ref:`ShadowMode` **get_shadow_mode**\ (\ ) -灯光的阴影渲染算法。见 :ref:`ShadowMode`\ 。 +灯光的阴影渲染算法。 .. rst-class:: classref-item-separator @@ -290,9 +292,10 @@ enum **SkyMode**: :ref:`🔗` - |void| **set_sky_mode**\ (\ value\: :ref:`SkyMode`\ ) - :ref:`SkyMode` **get_sky_mode**\ (\ ) -设置该 **DirectionalLight3D** 是仅在天空中可见，仅在场景中可见，还是在天空和场景中均可见。选项见 :ref:`SkyMode`\ 。 +设置该 **DirectionalLight3D** 是仅在天空中可见，仅在场景中可见，还是在天空和场景中均可见。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_displayserver.rst b/classes/zh_CN/class_displayserver.rst index 84353a01e7..26682755f8 100644 --- a/classes/zh_CN/class_displayserver.rst +++ b/classes/zh_CN/class_displayserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DisplayServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DisplayServer.xml. .. _class_DisplayServer: @@ -31,387 +31,543 @@ DisplayServer .. table:: :widths: auto - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`beep`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`clipboard_get_image`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get_primary`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has_image`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clipboard_set`\ (\ clipboard\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cursor_set_custom_image`\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cursor_set_shape`\ (\ shape\: :ref:`CursorShape`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`delete_status_indicator`\ (\ id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_input_text`\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_show`\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`enable_for_stealing_focus`\ (\ process_id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_with_options_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`force_process_and_drop_events`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_accent_color`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_base_color`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Rect2`\] | :ref:`get_display_cutouts`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_display_safe_area`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_keyboard_focus_screen`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_primary_screen`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_from_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_swap_cancel_ok`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_window_at_screen_position`\ (\ position\: :ref:`Vector2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_window_list`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_multistate_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_radio_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_separator`\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_submenu_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_clear`\ (\ menu_root\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`global_menu_get_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_count`\ (\ menu_root\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`global_menu_get_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_tag`\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_text`\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`global_menu_get_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_remove_item`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_hover_callbacks`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_popup_callbacks`\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_additional_outputs`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_hardware_keyboard`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`ime_get_text`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode_supported`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_label_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_layout_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_language`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_name`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`keyboard_set_current_layout`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`mouse_get_button_state`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MouseMode` | :ref:`mouse_get_mode`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`mouse_get_position`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`mouse_set_mode`\ (\ mouse_mode\: :ref:`MouseMode`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`process_events`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_additional_output`\ (\ object\: :ref:`Object`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_dpi`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`screen_get_image`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`screen_get_image_rect`\ (\ rect\: :ref:`Rect2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_max_scale`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScreenOrientation` | :ref:`screen_get_orientation`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`screen_get_pixel`\ (\ position\: :ref:`Vector2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_position`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_refresh_rate`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_scale`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_size`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`screen_get_usable_rect`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`screen_is_kept_on`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`screen_set_keep_on`\ (\ enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`screen_set_orientation`\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon`\ (\ image\: :ref:`Image`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_native_icon`\ (\ filename\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`show_emoji_and_symbol_picker`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_menu`\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_current_driver`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`tablet_get_driver_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_driver_name`\ (\ idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tablet_set_current_driver`\ (\ name\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`tts_get_voices`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language`\ (\ language\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_paused`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_speaking`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_pause`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_resume`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_set_utterance_callback`\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_speak`\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_stop`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_additional_output`\ (\ object\: :ref:`Object`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`virtual_keyboard_get_height`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`virtual_keyboard_hide`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`virtual_keyboard_show`\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2i`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_can_draw`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_active_popup`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_attached_instance_id`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_current_screen`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_get_flag`\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_max_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_min_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WindowMode` | :ref:`window_get_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_native_handle`\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect`\ (\ window\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`window_get_safe_title_margins`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_title_size`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VSyncMode` | :ref:`window_get_vsync_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_focused`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_maximize_allowed`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_move_to_foreground`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_request_attention`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_current_screen`\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_drop_files_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_exclusive`\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_flag`\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_ime_active`\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_ime_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_input_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_input_text_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_max_size`\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_min_size`\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_mode`\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_mouse_passthrough`\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_popup_safe_rect`\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_rect_changed_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_size`\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_title`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_transient`\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_vsync_mode`\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_window_buttons_offset`\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_window_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_start_drag`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_start_resize`\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_create_element`\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_create_sub_element`\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_create_sub_text_edit_elements`\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`accessibility_element_get_meta`\ (\ id\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_element_set_meta`\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_free_element`\ (\ id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_get_window_root`\ (\ window_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`accessibility_has_element`\ (\ id\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_screen_reader_active`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_set_window_focused`\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_set_window_rect`\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_increase_contrast`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_reduce_animation`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_reduce_transparency`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_action`\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_child`\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_custom_action`\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_controls`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_described_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_details`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_flow_to`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_labeled_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_radio_group`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_active_descendant`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_background_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_bounds`\ (\ id\: :ref:`RID`, p_rect\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_checked`\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_classname`\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_color_value`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_error_message`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_extra_info`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_flag`\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_focus`\ (\ id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_foreground_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_in_page_link_target`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_language`\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_count`\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_expanded`\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_level`\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_selected`\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_live`\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_member_of`\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_name`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_next_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_jump`\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_step`\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_value`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_placeholder`\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_popup_type`\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_previous_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_role`\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_role_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_x`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_x_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_y`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_y_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_shortcut`\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_state_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_cell_position`\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_cell_span`\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_column_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_column_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_row_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_row_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_align`\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_decorations`\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_selection`\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_tooltip`\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_transform`\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_url`\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_value`\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`beep`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`clipboard_get_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get_primary`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set`\ (\ clipboard\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`color_picker`\ (\ callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_custom_image`\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_shape`\ (\ shape\: :ref:`CursorShape`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_status_indicator`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_input_text`\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_show`\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`enable_for_stealing_focus`\ (\ process_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_with_options_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_process_and_drop_events`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_accent_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_base_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Rect2`\] | :ref:`get_display_cutouts`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_display_safe_area`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_keyboard_focus_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_primary_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_from_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_swap_cancel_ok`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_window_at_screen_position`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_window_list`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_multistate_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_radio_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_separator`\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_submenu_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_clear`\ (\ menu_root\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`global_menu_get_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_count`\ (\ menu_root\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`global_menu_get_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_tag`\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_text`\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`global_menu_get_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_remove_item`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hover_callbacks`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_popup_callbacks`\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_additional_outputs`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_hardware_keyboard`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ime_get_text`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode_supported`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_label_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_layout_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_language`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`keyboard_set_current_layout`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`mouse_get_button_state`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MouseMode` | :ref:`mouse_get_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`mouse_get_position`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mouse_set_mode`\ (\ mouse_mode\: :ref:`MouseMode`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`process_events`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_additional_output`\ (\ object\: :ref:`Object`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_dpi`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`screen_get_image`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`screen_get_image_rect`\ (\ rect\: :ref:`Rect2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_max_scale`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScreenOrientation` | :ref:`screen_get_orientation`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`screen_get_pixel`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_position`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_refresh_rate`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_scale`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_size`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`screen_get_usable_rect`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen_is_kept_on`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_keep_on`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_orientation`\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_hardware_keyboard_connection_change_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ image\: :ref:`Image`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_native_icon`\ (\ filename\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_emoji_and_symbol_picker`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_menu`\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_current_driver`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`tablet_get_driver_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_driver_name`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tablet_set_current_driver`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`tts_get_voices`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language`\ (\ language\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_paused`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_speaking`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_pause`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_resume`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_set_utterance_callback`\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_speak`\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_stop`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_additional_output`\ (\ object\: :ref:`Object`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`virtual_keyboard_get_height`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_hide`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_show`\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2i`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_can_draw`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_active_popup`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_attached_instance_id`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_current_screen`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_get_flag`\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_max_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_min_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WindowMode` | :ref:`window_get_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_native_handle`\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect`\ (\ window\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`window_get_safe_title_margins`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_title_size`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VSyncMode` | :ref:`window_get_vsync_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_focused`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_maximize_allowed`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_move_to_foreground`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_request_attention`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_current_screen`\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_drop_files_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_exclusive`\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_flag`\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_active`\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_text_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_max_size`\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_min_size`\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mode`\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mouse_passthrough`\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_popup_safe_rect`\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_rect_changed_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_size`\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_title`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_transient`\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_vsync_mode`\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_buttons_offset`\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_start_drag`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_start_resize`\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -524,7 +680,7 @@ enum **Feature**: :ref:`🔗` :ref:`Feature` **FEATURE_WINDOW_TRANSPARENCY** = ``11`` -显示服务器支持窗口可以使用逐像素透明，以使它们后面的窗口部分或完全可见。\ **Windows、macOS、Linux（X11/Wayland）** +显示服务器支持窗口可以使用逐像素透明，以使它们后面的窗口部分或完全可见。\ **Windows、macOS、Linux（X11/Wayland）、Android** .. _class_DisplayServer_constant_FEATURE_HIDPI: @@ -652,7 +808,7 @@ enum **Feature**: :ref:`🔗` :ref:`Feature` **FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE** = ``28`` -显示服务器支持窗口标志 :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE`\ 。 +Display server supports :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE` window flag. **Windows, macOS** .. _class_DisplayServer_constant_FEATURE_WINDOW_EMBEDDING: @@ -660,7 +816,7 @@ enum **Feature**: :ref:`🔗` :ref:`Feature` **FEATURE_WINDOW_EMBEDDING** = ``29`` -显示服务器支持嵌入其他进程的窗口。\ **Windows、Linux（X11）** +Display server supports embedding a window from another process. **Windows, Linux (X11), macOS** .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_MIME: @@ -678,6 +834,860 @@ enum **Feature**: :ref:`🔗` 显示服务器支持系统 Emoji 和符号拾取器。\ **Windows、macOS** +.. _class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_NATIVE_COLOR_PICKER** = ``32`` + +显示服务器支持原生取色器。\ **Linux（X11/Wayland）** + +.. _class_DisplayServer_constant_FEATURE_SELF_FITTING_WINDOWS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_SELF_FITTING_WINDOWS** = ``33`` + +显示服务器会根据屏幕边界自动调整弹出窗口的大小。Window 节点不应该自行进行此类调整。 + +.. _class_DisplayServer_constant_FEATURE_ACCESSIBILITY_SCREEN_READER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_ACCESSIBILITY_SCREEN_READER** = ``34`` + +显示服务器支持与屏幕阅读器或盲文显示器的交互。\ **Linux（X11/Wayland）、macOS、Windows** + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityRole: + +.. rst-class:: classref-enumeration + +enum **AccessibilityRole**: :ref:`🔗` + +.. _class_DisplayServer_constant_ROLE_UNKNOWN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_UNKNOWN** = ``0`` + +未知角色或自定义角色。 + +.. _class_DisplayServer_constant_ROLE_DEFAULT_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_DEFAULT_BUTTON** = ``1`` + +默认对话框按钮元素。 + +.. _class_DisplayServer_constant_ROLE_AUDIO: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_AUDIO** = ``2`` + +音频播放器元素。 + +.. _class_DisplayServer_constant_ROLE_VIDEO: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_VIDEO** = ``3`` + +视频播放器元素。 + +.. _class_DisplayServer_constant_ROLE_STATIC_TEXT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_STATIC_TEXT** = ``4`` + +不可编辑的文本标签。 + +.. _class_DisplayServer_constant_ROLE_CONTAINER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_CONTAINER** = ``5`` + +容器元素。带有该角色的元素用于内部结构，会被屏幕阅读器忽略。 + +.. _class_DisplayServer_constant_ROLE_PANEL: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_PANEL** = ``6`` + +面板容器元素。 + +.. _class_DisplayServer_constant_ROLE_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_BUTTON** = ``7`` + +按钮元素。 + +.. _class_DisplayServer_constant_ROLE_LINK: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_LINK** = ``8`` + +链接元素。 + +.. _class_DisplayServer_constant_ROLE_CHECK_BOX: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_CHECK_BOX** = ``9`` + +复选框元素。 + +.. _class_DisplayServer_constant_ROLE_RADIO_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_RADIO_BUTTON** = ``10`` + +单选按钮元素。 + +.. _class_DisplayServer_constant_ROLE_CHECK_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_CHECK_BUTTON** = ``11`` + +复选按钮元素。 + +.. _class_DisplayServer_constant_ROLE_SCROLL_BAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_SCROLL_BAR** = ``12`` + +滚动条元素。 + +.. _class_DisplayServer_constant_ROLE_SCROLL_VIEW: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_SCROLL_VIEW** = ``13`` + +滚动容器元素。 + +.. _class_DisplayServer_constant_ROLE_SPLITTER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_SPLITTER** = ``14`` + +容器拆分器手柄元素。 + +.. _class_DisplayServer_constant_ROLE_SLIDER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_SLIDER** = ``15`` + +滑块元素。 + +.. _class_DisplayServer_constant_ROLE_SPIN_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_SPIN_BUTTON** = ``16`` + +数字输入框元素。 + +.. _class_DisplayServer_constant_ROLE_PROGRESS_INDICATOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_PROGRESS_INDICATOR** = ``17`` + +进度指示元素。 + +.. _class_DisplayServer_constant_ROLE_TEXT_FIELD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TEXT_FIELD** = ``18`` + +可编辑文本框元素。 + +.. _class_DisplayServer_constant_ROLE_MULTILINE_TEXT_FIELD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MULTILINE_TEXT_FIELD** = ``19`` + +多行可编辑文本框元素。 + +.. _class_DisplayServer_constant_ROLE_COLOR_PICKER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_COLOR_PICKER** = ``20`` + +取色器元素。 + +.. _class_DisplayServer_constant_ROLE_TABLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TABLE** = ``21`` + +表格元素。 + +.. _class_DisplayServer_constant_ROLE_CELL: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_CELL** = ``22`` + +表格/树中的单元格元素。 + +.. _class_DisplayServer_constant_ROLE_ROW: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_ROW** = ``23`` + +表格/树中的行元素。 + +.. _class_DisplayServer_constant_ROLE_ROW_GROUP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_ROW_GROUP** = ``24`` + +表格/树中的行分组元素。 + +.. _class_DisplayServer_constant_ROLE_ROW_HEADER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_ROW_HEADER** = ``25`` + +表格/树中的行头元素。 + +.. _class_DisplayServer_constant_ROLE_COLUMN_HEADER: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_COLUMN_HEADER** = ``26`` + +表格/树中的列头元素。 + +.. _class_DisplayServer_constant_ROLE_TREE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TREE** = ``27`` + +树视图元素。 + +.. _class_DisplayServer_constant_ROLE_TREE_ITEM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TREE_ITEM** = ``28`` + +树视图项元素。 + +.. _class_DisplayServer_constant_ROLE_LIST: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_LIST** = ``29`` + +列表元素。 + +.. _class_DisplayServer_constant_ROLE_LIST_ITEM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_LIST_ITEM** = ``30`` + +列表项元素。 + +.. _class_DisplayServer_constant_ROLE_LIST_BOX: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_LIST_BOX** = ``31`` + +列表视图元素。 + +.. _class_DisplayServer_constant_ROLE_LIST_BOX_OPTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_LIST_BOX_OPTION** = ``32`` + +列表视图项元素。 + +.. _class_DisplayServer_constant_ROLE_TAB_BAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TAB_BAR** = ``33`` + +选项卡栏元素。 + +.. _class_DisplayServer_constant_ROLE_TAB: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TAB** = ``34`` + +选项卡栏项目元素。 + +.. _class_DisplayServer_constant_ROLE_TAB_PANEL: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TAB_PANEL** = ``35`` + +选项卡面板元素。 + +.. _class_DisplayServer_constant_ROLE_MENU_BAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU_BAR** = ``36`` + +菜单栏元素。 + +.. _class_DisplayServer_constant_ROLE_MENU: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU** = ``37`` + +弹出菜单元素。 + +.. _class_DisplayServer_constant_ROLE_MENU_ITEM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU_ITEM** = ``38`` + +弹出菜单项元素。 + +.. _class_DisplayServer_constant_ROLE_MENU_ITEM_CHECK_BOX: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU_ITEM_CHECK_BOX** = ``39`` + +弹出菜单复选按钮菜单项元素。 + +.. _class_DisplayServer_constant_ROLE_MENU_ITEM_RADIO: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU_ITEM_RADIO** = ``40`` + +弹出菜单单选按钮菜单项元素。 + +.. _class_DisplayServer_constant_ROLE_IMAGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_IMAGE** = ``41`` + +图像元素。 + +.. _class_DisplayServer_constant_ROLE_WINDOW: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_WINDOW** = ``42`` + +窗口元素。 + +.. _class_DisplayServer_constant_ROLE_TITLE_BAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TITLE_BAR** = ``43`` + +内嵌窗口标题栏元素。 + +.. _class_DisplayServer_constant_ROLE_DIALOG: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_DIALOG** = ``44`` + +对话框窗口元素。 + +.. _class_DisplayServer_constant_ROLE_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_TOOLTIP** = ``45`` + +工具提示元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityPopupType: + +.. rst-class:: classref-enumeration + +enum **AccessibilityPopupType**: :ref:`🔗` + +.. _class_DisplayServer_constant_POPUP_MENU: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityPopupType` **POPUP_MENU** = ``0`` + +弹出菜单元素。 + +.. _class_DisplayServer_constant_POPUP_LIST: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityPopupType` **POPUP_LIST** = ``1`` + +弹出列表。 + +.. _class_DisplayServer_constant_POPUP_TREE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityPopupType` **POPUP_TREE** = ``2`` + +弹出树视图。 + +.. _class_DisplayServer_constant_POPUP_DIALOG: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityPopupType` **POPUP_DIALOG** = ``3`` + +弹出对话框。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityFlags: + +.. rst-class:: classref-enumeration + +enum **AccessibilityFlags**: :ref:`🔗` + +.. _class_DisplayServer_constant_FLAG_HIDDEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_HIDDEN** = ``0`` + +元素对无障碍工具隐藏。 + +.. _class_DisplayServer_constant_FLAG_MULTISELECTABLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_MULTISELECTABLE** = ``1`` + +元素支持多项选择。 + +.. _class_DisplayServer_constant_FLAG_REQUIRED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_REQUIRED** = ``2`` + +元素要求用户输入。 + +.. _class_DisplayServer_constant_FLAG_VISITED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_VISITED** = ``3`` + +元素为已访问链接。 + +.. _class_DisplayServer_constant_FLAG_BUSY: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_BUSY** = ``4`` + +元素内容未就绪（例如正在加载）。 + +.. _class_DisplayServer_constant_FLAG_MODAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_MODAL** = ``5`` + +元素为模态窗口。 + +.. _class_DisplayServer_constant_FLAG_TOUCH_PASSTHROUGH: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_TOUCH_PASSTHROUGH** = ``6`` + +屏幕阅读器处于触摸探索模式时，元素允许触摸事件穿透。 + +.. _class_DisplayServer_constant_FLAG_READONLY: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_READONLY** = ``7`` + +元素是文本框，包含可选择但只读的文本。 + +.. _class_DisplayServer_constant_FLAG_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_DISABLED** = ``8`` + +元素已禁用。 + +.. _class_DisplayServer_constant_FLAG_CLIPS_CHILDREN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityFlags` **FLAG_CLIPS_CHILDREN** = ``9`` + +元素会裁剪子级。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityAction: + +.. rst-class:: classref-enumeration + +enum **AccessibilityAction**: :ref:`🔗` + +.. _class_DisplayServer_constant_ACTION_CLICK: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_CLICK** = ``0`` + +单击动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_FOCUS: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_FOCUS** = ``1`` + +聚焦动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_BLUR: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_BLUR** = ``2`` + +散焦动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_COLLAPSE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_COLLAPSE** = ``3`` + +折叠动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_EXPAND: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_EXPAND** = ``4`` + +展开动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_DECREMENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_DECREMENT** = ``5`` + +下调动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_INCREMENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_INCREMENT** = ``6`` + +上调动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_HIDE_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_HIDE_TOOLTIP** = ``7`` + +隐藏工具提示动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_SHOW_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SHOW_TOOLTIP** = ``8`` + +显示工具提示动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_SET_TEXT_SELECTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_TEXT_SELECTION** = ``9`` + +文本选区动作，回调参数被设置为 :ref:`Dictionary`\ ，带有以下键： + +- ``"start_element"`` 选区起点的无障碍元素。 + +- ``"start_char"`` 相对于选区起点无障碍元素的字符偏移量。 + +- ``"end_element"`` 选区终点的无障碍元素。 + +- ``"end_char"`` 相对于选区终点无障碍元素的字符偏移量。 + +.. _class_DisplayServer_constant_ACTION_REPLACE_SELECTED_TEXT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_REPLACE_SELECTED_TEXT** = ``10`` + +替换文本动作，回调参数被设置为 :ref:`String`\ ，表示替换后的文本。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_BACKWARD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_BACKWARD** = ``11`` + +向后滚动动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_DOWN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_DOWN** = ``12`` + +向下滚动动作，回调参数被设置为 :ref:`AccessibilityScrollUnit`\ 。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_FORWARD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_FORWARD** = ``13`` + +向前滚动动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_LEFT** = ``14`` + +向左滚动动作，回调参数被设置为 :ref:`AccessibilityScrollUnit`\ 。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_RIGHT** = ``15`` + +向右滚动动作，回调参数被设置为 :ref:`AccessibilityScrollUnit`\ 。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_UP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_UP** = ``16`` + +向上滚动动作，回调参数被设置为 :ref:`AccessibilityScrollUnit`\ 。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_INTO_VIEW: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_INTO_VIEW** = ``17`` + +滚动至视图动作，回调参数被设置为 :ref:`AccessibilityScrollHint`\ 。 + +.. _class_DisplayServer_constant_ACTION_SCROLL_TO_POINT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_TO_POINT** = ``18`` + +滚动至点动作，回调参数被设置为 :ref:`Vector2`\ ，表示点的相对坐标。 + +.. _class_DisplayServer_constant_ACTION_SET_SCROLL_OFFSET: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_SCROLL_OFFSET** = ``19`` + +设置滚动偏移量动作，回调参数被设置为 :ref:`Vector2`\ ，表示滚动偏移量。 + +.. _class_DisplayServer_constant_ACTION_SET_VALUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_VALUE** = ``20`` + +设值动作，回调参数被设置为 :ref:`String` 或数字，表示新值。 + +.. _class_DisplayServer_constant_ACTION_SHOW_CONTEXT_MENU: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SHOW_CONTEXT_MENU** = ``21`` + +显示上下文菜单动作，不设置回调参数。 + +.. _class_DisplayServer_constant_ACTION_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_CUSTOM** = ``22`` + +自定义动作，回调参数被设置为整数动作 ID。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityLiveMode: + +.. rst-class:: classref-enumeration + +enum **AccessibilityLiveMode**: :ref:`🔗` + +.. _class_DisplayServer_constant_LIVE_OFF: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityLiveMode` **LIVE_OFF** = ``0`` + +表示不应展示对实时区域的更新。 + +.. _class_DisplayServer_constant_LIVE_POLITE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityLiveMode` **LIVE_POLITE** = ``1`` + +表示对实时区域的更新应在下次机会时展示（例如讲完当前句子后）。 + +.. _class_DisplayServer_constant_LIVE_ASSERTIVE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityLiveMode` **LIVE_ASSERTIVE** = ``2`` + +表示对实时区域的更新具有最高优先级，应立即展示。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityScrollUnit: + +.. rst-class:: classref-enumeration + +enum **AccessibilityScrollUnit**: :ref:`🔗` + +.. _class_DisplayServer_constant_SCROLL_UNIT_ITEM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollUnit` **SCROLL_UNIT_ITEM** = ``0`` + +要滚动的量度。列表中的单个项目，一行文本。 + +.. _class_DisplayServer_constant_SCROLL_UNIT_PAGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollUnit` **SCROLL_UNIT_PAGE** = ``1`` + +要滚动的量度。单页。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_AccessibilityScrollHint: + +.. rst-class:: classref-enumeration + +enum **AccessibilityScrollHint**: :ref:`🔗` + +.. _class_DisplayServer_constant_SCROLL_HINT_TOP_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_TOP_LEFT** = ``0`` + +节点滚动到视图的首选位置。滚动容器的左上边缘。 + +.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_BOTTOM_RIGHT** = ``1`` + +节点滚动到视图的首选位置。滚动容器的右下边缘。 + +.. _class_DisplayServer_constant_SCROLL_HINT_TOP_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_TOP_EDGE** = ``2`` + +节点滚动到视图的首选位置。滚动容器的顶部边缘。 + +.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_BOTTOM_EDGE** = ``3`` + +节点滚动到视图的首选位置。滚动容器的底部边缘。 + +.. _class_DisplayServer_constant_SCROLL_HINT_LEFT_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_LEFT_EDGE** = ``4`` + +节点滚动到视图的首选位置。滚动容器的左部边缘。 + +.. _class_DisplayServer_constant_SCROLL_HINT_RIGHT_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityScrollHint` **SCROLL_HINT_RIGHT_EDGE** = ``5`` + +节点滚动到视图的首选位置。滚动容器的右部边缘。 + .. rst-class:: classref-item-separator ---- @@ -1130,8 +2140,6 @@ enum **WindowMode**: :ref:`🔗` \ **在 Android 上：**\ 将启用沉浸模式。 -\ **在 Windows 上：**\ 多窗口全屏模式具有 1px 宽的颜色为 :ref:`ProjectSettings.rendering/environment/defaults/default_clear_color` 的边框。 - \ **在 macOS 上：**\ 使用新桌面来显示正在运行的项目。 \ **注意：**\ 无论平台如何，启用全屏都会更改窗口大小以匹配显示器的大小。因此，请确保你的项目在启用全屏模式时支持\ :doc:`多种分辨率 <../tutorials/rendering/multiple_resolutions>`\ 。 @@ -1146,6 +2154,8 @@ enum **WindowMode**: :ref:`🔗` 全屏窗口会覆盖屏幕的整个显示区域，没有边框或装饰。显示视频模式没有改变。 +\ **注意：**\ 该模式可能不适用于屏幕录制软件。 + \ **在 Android 上：**\ 将启用沉浸模式。 \ **在 Windows 上：**\ 取决于视频驱动程序，全屏过渡可能会导致屏幕暂时变黑。 @@ -1204,6 +2214,8 @@ enum **WindowFlags**: :ref:`🔗` \ **注意：**\ Linux （X11/Wayland）、macOS 和 Windows 上实现了透明支持，但可用性可能因 GPU 驱动程序、显示管理器和合成器功能而异。 +\ **注意：**\ Android 系统已实现透明支持，但只能通过 :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed` 启用。该标志在 Android 上无效。 + .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS: .. rst-class:: classref-enumeration-constant @@ -1258,17 +2270,45 @@ enum **WindowFlags**: :ref:`🔗` :ref:`WindowFlags` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9`` -在 :ref:`screen_get_image()`\ 、\ :ref:`screen_get_image_rect()` 和 :ref:`screen_get_pixel()` 的截图中排除该窗口。 +Window is excluded from screenshots taken by :ref:`screen_get_image()`, :ref:`screen_get_image_rect()`, and :ref:`screen_get_pixel()`. + +\ **Note:** This flag is implemented on macOS and Windows (10, 20H1). + +\ **Note:** Setting this flag will prevent standard screenshot methods from capturing a window image, but does **NOT** guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure. + +.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_POPUP_WM_HINT** = ``10`` + +向窗口管理器发出信号，表明该窗口应该是实现定义的“弹出窗口” （通常是浮动、无边框、不可平铺且不可移动的子窗口）。 + +.. _class_DisplayServer_constant_WINDOW_FLAG_MINIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MINIMIZE_DISABLED** = ``11`` + +禁用窗口的最小化按钮。 \ **注意：**\ 该标志在 macOS 和 Windows 上实现。 -\ **注意：**\ 设置该标志\ **不会**\ 阻止其他应用进行截图，不应用作安全措施。 +.. _class_DisplayServer_constant_WINDOW_FLAG_MAXIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MAXIMIZE_DISABLED** = ``12`` + +禁用窗口的最大化按钮。 + +\ **注意：**\ 该标志在 macOS 和 Windows 上实现。 .. _class_DisplayServer_constant_WINDOW_FLAG_MAX: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_MAX** = ``10`` +:ref:`WindowFlags` **WINDOW_FLAG_MAX** = ``13`` :ref:`WindowFlags` 的最大值。 @@ -1340,7 +2380,7 @@ enum **WindowEvent**: :ref:`🔗` 当窗口被移动到具有不同 DPI 的显示器上，或者显示器的 DPI 更改时发送。 -\ **注意：**\ 该标志仅在 macOS 上实现。 +\ **注意：**\ 该标志仅在 macOS 和 Linux（Wayland）上实现。 .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE: @@ -1352,6 +2392,16 @@ enum **WindowEvent**: :ref:`🔗` \ **注意：**\ 该标志仅在 macOS 上实现。 +.. _class_DisplayServer_constant_WINDOW_EVENT_FORCE_CLOSE: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_FORCE_CLOSE** = ``8`` + +当窗口被显示服务器强制关闭时发送。该窗口应立即隐藏并清理内部的渲染引用。 + +\ **注意：**\ 该标志仅在 Linux（Wayland）上实现。 + .. rst-class:: classref-item-separator ---- @@ -1629,6 +2679,14 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 常量 ---- +.. _class_DisplayServer_constant_INVALID_SCREEN: + +.. rst-class:: classref-constant + +**INVALID_SCREEN** = ``-1`` :ref:`🔗` + +指向一个不存在屏幕的 ID。如果没有屏幕与请求的结果相匹配，某些 **DisplayServer** 方法将返回这个 ID。 + .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS: .. rst-class:: classref-constant @@ -1637,7 +2695,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 表示包含鼠标指针的屏幕。 -\ **注意：**\ 在 Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 +\ **注意：**\ 在 Android、iOS、Web、Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS: @@ -1647,7 +2705,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 表示包含具有键盘焦点的窗口的屏幕。 -\ **注意：**\ 在 Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 +\ **注意：**\ 在 Android、iOS、Web、Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 .. _class_DisplayServer_constant_SCREEN_PRIMARY: @@ -1657,7 +2715,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 代表主屏幕。 -\ **注意：**\ 在 Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 +\ **注意：**\ 在 Android、iOS、Web、Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW: @@ -1667,7 +2725,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 代表主窗口所在的屏幕。这通常是允许指定多个屏幕之一的函数中的默认值。 -\ **注意：**\ 在 Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 +\ **注意：**\ 在 Android、iOS、Web、Linux（Wayland）上，该常量始终代表索引 ``0`` 处的屏幕。 .. _class_DisplayServer_constant_MAIN_WINDOW_ID: @@ -1702,6 +2760,942 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 方法说明 -------- +.. _class_DisplayServer_method_accessibility_create_element: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_create_element**\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` + +新建空的无障碍元素资源。 + +\ **注意：**\ 每个 :ref:`Node` 都会自动创建并释放无障碍元素。一般来说不应手动调用该函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_create_sub_element: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_create_sub_element**\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) :ref:`🔗` + +新建空的无障碍子元素资源。子元素可用于为非 :ref:`Node` 对象提供无障碍信息，例如列表项、表格单元格或菜单项。子元素在父元素被释放时会自动释放，也可以通过 :ref:`accessibility_free_element()` 方法提前释放。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_create_sub_text_edit_elements: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1\ ) :ref:`🔗` + +从形状文本缓冲区新建空的无障碍子元素。子元素在父元素被释放时会自动释放，也可以通过 :ref:`accessibility_free_element()` 方法提前释放。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_element_get_meta: + +.. rst-class:: classref-method + +:ref:`Variant` **accessibility_element_get_meta**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回无障碍元素的元数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_element_set_meta: + +.. rst-class:: classref-method + +|void| **accessibility_element_set_meta**\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) :ref:`🔗` + +设置无障碍元素的元数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_free_element: + +.. rst-class:: classref-method + +|void| **accessibility_free_element**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` + +释放由 :ref:`accessibility_create_element()`\ 、\ :ref:`accessibility_create_sub_element()` 或 :ref:`accessibility_create_sub_text_edit_elements()` 创建的对象。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_get_window_root: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_get_window_root**\ (\ window_id\: :ref:`int`\ ) |const| :ref:`🔗` + +返回操作系统原生窗口的主要无障碍元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_has_element: + +.. rst-class:: classref-method + +:ref:`bool` **accessibility_has_element**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` + +如果 ``id`` 是有效的无障碍元素，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_screen_reader_active: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_screen_reader_active**\ (\ ) |const| :ref:`🔗` + +如果屏幕阅读器、盲文显示器或其他辅助应用处于活动状态则返回 ``1``\ ， 否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。 + +\ **注意：**\ 该方法在 Linux、macOS 和 Windows 上实现。 + +\ **注意：**\ Windows 的 Accessibility Insights、macOS 的 Accessibility Inspector、AT-SPI 浏览器等无障碍调试工具不算作辅助应用，不影响取值。要使用这些工具测试应用，请将 :ref:`ProjectSettings.accessibility/general/accessibility_support` 设置为 ``1``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_set_window_focused: + +.. rst-class:: classref-method + +|void| **accessibility_set_window_focused**\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) :ref:`🔗` + +设置辅助应用的窗口聚焦状态。 + +\ **注意：**\ 该方法在 Linux、macOS 和 Windows 上实现。 + +\ **注意：**\ 仅限高级用户！\ :ref:`Window` 对象会自动调用此方法。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_set_window_rect: + +.. rst-class:: classref-method + +|void| **accessibility_set_window_rect**\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) :ref:`🔗` + +设置辅助应用的窗口外部边界（带装饰）和内部边界（不带装饰）。 + +\ **注意：**\ 该方法在 Linux、macOS 和 Windows 上实现。 + +\ **注意：**\ 仅限高级用户！\ :ref:`Window` 对象会自动调用此方法。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_increase_contrast: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_increase_contrast**\ (\ ) |const| :ref:`🔗` + +如果应该使用高对比度用户界面主题则返回 ``1``\ ，否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。 + +\ **注意：**\ 该方法在 Linux（X11/Wayland、GNOME）、macOS 和 Windows 上实现。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_reduce_animation: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_reduce_animation**\ (\ ) |const| :ref:`🔗` + +如果应禁用闪烁、闪烁等可能导致光敏性癫痫用户发作的动态内容则返回 ``1``\ ，否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。 + +\ **注意：**\ 该方法在 macOS 和 Windows 上实现。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_reduce_transparency: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_reduce_transparency**\ (\ ) |const| :ref:`🔗` + +如果应禁用背景图像、透明度等可能降低前景与背景对比度的特性则返回 ``1``\ ，否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。 + +\ **注意：**\ 该方法在 macOS 和 Windows 上实现。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_action: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_action**\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) :ref:`🔗` + +添加无障碍动作的回调（可以通过使用特殊的屏幕阅读器命令或盲文显示器上的按钮执行的动作），并将该动作标记为支持。动作回调接收一个 :ref:`Variant` 参数，取值由动作类型决定。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_child: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_child**\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) :ref:`🔗` + +添加子级无障碍元素。 + +\ **注意：**\ :ref:`Node` 子节点和子元素会自动添加至子级列表。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_custom_action: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_custom_action**\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) :ref:`🔗` + +添加对自定义无障碍动作的支持。\ ``action_id`` 会作为参数传递给 :ref:`ACTION_CUSTOM` 动作的回调。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_controls: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_controls**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加由该元素控制的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_described_by: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_described_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加描述该元素的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_details: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_details**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加补充该元素的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_flow_to: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_flow_to**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加该元素流入的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_labeled_by: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_labeled_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加作为该元素标签的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_radio_group: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_radio_group**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +添加同一单选组中的元素。 + +\ **注意：**\ 单选组中的每个元素都应该调用该方法，使用其他元素作为 ``related_id``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_active_descendant: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_active_descendant**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +添加该元素的活动派生元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_background_color: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_background_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +设置元素的背景色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_bounds: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_bounds**\ (\ id\: :ref:`RID`, p_rect\: :ref:`Rect2`\ ) :ref:`🔗` + +设置元素的边界框，相对于节点的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_checked: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_checked**\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) :ref:`🔗` + +设置元素的复选状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_classname: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_classname**\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) :ref:`🔗` + +设置元素的类名。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_color_value: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_color_value**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +设置元素的颜色值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_description: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` + +设置元素的无障碍描述。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_error_message: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_error_message**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +设置包含该元素错误消息的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_extra_info: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_extra_info**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` + +设置为元素名添加的元素无障碍额外信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_flag: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_flag**\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) :ref:`🔗` + +设置元素的标志。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_focus: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_focus**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` + +设置当前聚焦的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_foreground_color: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_foreground_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +设置元素的前景色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_in_page_link_target: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_in_page_link_target**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +设置链接的目标元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_language: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_language**\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) :ref:`🔗` + +设置元素的文本语言。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_count: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_count**\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) :ref:`🔗` + +设置列表中的项目数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_expanded: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_expanded**\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) :ref:`🔗` + +设置列表项/树项目的展开状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_index: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` + +设置元素在列表中的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_level: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_level**\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) :ref:`🔗` + +设置元素在列表中的层级。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_selected: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_selected**\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) :ref:`🔗` + +设置列表项/树项目的选中状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_orientation: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` + +设置列表元素的朝向。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_live: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_live**\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) :ref:`🔗` + +设置实时区域更新的优先级。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_member_of: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_member_of**\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) :ref:`🔗` + +将元素设置为分组的成员。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_name: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` + +设置元素的无障碍名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_next_on_line: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_next_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +设置位于同一行的下一个元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_jump: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_jump**\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) :ref:`🔗` + +设置数值的跳变。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_range: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` + +设置数值的范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_step: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_step**\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) :ref:`🔗` + +设置数值的步长。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_value: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_value**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` + +设置数值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_placeholder: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_placeholder**\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) :ref:`🔗` + +设置占位文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_popup_type: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_popup_type**\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) :ref:`🔗` + +设置弹出按钮的弹出类型。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_previous_on_line: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_previous_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +设置位于同一行的上一个元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_role: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_role**\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` + +设置元素的无障碍角色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_role_description: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_role_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` + +设置元素的无障碍角色描述文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_scroll_x: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_scroll_x**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` + +设置滚动条 X 位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_scroll_x_range: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_scroll_x_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` + +设置滚动条 X 范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_scroll_y: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_scroll_y**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` + +设置滚动条 Y 位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_scroll_y_range: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_scroll_y_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` + +设置滚动条 Y 范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_shortcut: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_shortcut**\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) :ref:`🔗` + +设置元素使用的键盘快捷键列表。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_state_description: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_state_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` + +设置当前复选状态的人类可读描述。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_cell_position: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_cell_position**\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) :ref:`🔗` + +设置单元格在表格中的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_cell_span: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_cell_span**\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) :ref:`🔗` + +设置单元格的跨行/跨列。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_column_count: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_column_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` + +设置表格中的列数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_column_index: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_column_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` + +设置列的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_row_count: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_row_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` + +设置表格中的行数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_table_row_index: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_table_row_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` + +设置行在表格中的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_text_align: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_text_align**\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` + +设置元素的文本对齐。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_text_decorations: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_text_decorations**\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`\ ) :ref:`🔗` + +设置文本的下划线、上划线、删除线。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_text_orientation: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_text_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` + +设置文本朝向。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_text_selection: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_text_selection**\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) :ref:`🔗` + +设置文本框中的文本选择。\ ``text_start_id`` 和 ``text_end_id`` 应当是使用 :ref:`accessibility_create_sub_text_edit_elements()` 创建的元素。字符偏移量相对于对应的元素。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_tooltip: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_tooltip**\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) :ref:`🔗` + +设置工具提示文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_transform: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_transform**\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` + +设置元素的 2D 变换。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_url: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_url**\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) :ref:`🔗` + +设置链接 URL。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_value: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_value**\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) :ref:`🔗` + +设置元素文本值。 + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_beep: .. rst-class:: classref-method @@ -1806,6 +3800,24 @@ enum **TTSUtteranceEvent**: :ref:`🔗` ---- +.. _class_DisplayServer_method_color_picker: + +.. rst-class:: classref-method + +:ref:`bool` **color_picker**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` + +显示操作系统原生取色器。 + +回调的参数为：\ ``status: bool, color: Color``\ 。 + +\ **注意：**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_COLOR_PICKER` 功能，则该方法已被实现。 + +\ **注意：**\ 该方法仅在 Linux（X11/Wayland）上实现。 + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_create_status_indicator: .. rst-class:: classref-method @@ -1916,15 +3928,15 @@ enum **TTSUtteranceEvent**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` +:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) :ref:`🔗` 显示操作系统原生对话框，用于选择文件系统中的文件或目录。 \ ``filters`` 数组中的每个过滤器字符串都应该使用类似 ``*.png,*.jpg,*.jpeg;图像文件;image/png,image/jpeg`` 的格式。过滤器的描述文本不是必填项，可以省略。建议同时设置文件扩展名和 MIME 类型。另见 :ref:`FileDialog.filters`\ 。 -回调的参数如下：\ ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``\ 。\ **在 Android 平台**\ ，回调参数 ``selected_filter_index`` 始终为 0。 +回调的参数如下：\ ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``\ 。\ **在 Android 平台**\ ，第三个回调参数（\ ``selected_filter_index``\ ）始终为 ``0``\ 。 -\ **注意：**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_DIALOG` 功能，则该方法已被实现。支持的平台包括 Linux（X11/Wayland）、Windows、macOS 和 Android。 +\ **注意：**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_DIALOG` 功能，则该方法已被实现。支持的平台包括 Linux（X11/Wayland）、Windows、macOS 和 Android（API 级别 29+）。 \ **注意：**\ ``current_directory`` 可能会被忽略。 @@ -1944,7 +3956,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) :ref:`🔗` +:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) :ref:`🔗` 显示操作系统原生对话框，用于使用其他用户可选选项，选择文件系统中的文件或目录。 @@ -1996,9 +4008,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Color` **get_accent_color**\ (\ ) |const| :ref:`🔗` -返回操作系统主题色。如果主题色未知，则返回 ``Color(0, 0, 0, 0)``\ 。 +返回操作系统主题色。如果主题色未知则返回 ``Color(0, 0, 0, 0)``\ 。 -\ **注意：**\ 该方法在 macOS、Windows 和 Android 上实现。 +\ **注意：**\ 该方法在 macOS、Windows、Android、Linux（X11/Wayland）上实现。 .. rst-class:: classref-item-separator @@ -2052,7 +4064,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`🔗` -返回包含具有键盘焦点的窗口的屏幕索引，如果没有被聚焦的窗口，则返回主屏幕。 +返回包含具有键盘焦点的窗口的屏幕索引，如果没有被聚焦的窗口则返回主屏幕。 + +\ **注意：**\ 该方法在 Linux/X11、macOS、Windows 上实现。该方法在其他平台上始终返回主屏幕。 .. rst-class:: classref-item-separator @@ -2080,6 +4094,8 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 返回主屏幕的索引。 +\ **注意：**\ 该方法在 Linux/X11、macOS、Windows 上实现。该方法在其他平台上始终返回 ``0``\ 。 + .. rst-class:: classref-item-separator ---- @@ -2090,7 +4106,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **get_screen_count**\ (\ ) |const| :ref:`🔗` -返回可用的显示器数量。 +返回可用显示器的数量。 + +\ **注意：**\ 该方法在 Linux（X11 和 Wayland）、macOS、Windows 上实现。该方法在其他平台上始终返回 ``1``\ 。 .. rst-class:: classref-item-separator @@ -2102,7 +4120,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` -返回与给定矩形重合最多的屏幕的索引。如果矩形没有与任何屏幕重合或面积为零，则返回 ``-1``\ 。 +返回与给定矩形重叠最多的屏幕的索引。如果矩形没有与任何屏幕重叠或矩形面积为零，则返回 :ref:`INVALID_SCREEN`\ 。 .. rst-class:: classref-item-separator @@ -3143,7 +5161,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 如果连接了物理键盘，则返回 ``true``\ 。 -\ **注意：**\ 该方法在 Android 和 iOS 上实现，在其他平台上始终返回 ``true``\ 。 +\ **注意：**\ 该方法在 Android 和 iOS 上实现。该方法在其他平台上始终返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -3425,7 +5443,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **screen_get_dpi**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回指定屏幕的每英寸点数密度。如果 ``screen`` 为 :ref:`SCREEN_OF_MAIN_WINDOW`\ （默认值），则将使用带有主窗口的屏幕。 +返回指定屏幕的密度，单位为每英寸点数。如果 ``screen`` 无效则返回对应平台的默认值。 + +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 \ **注意：**\ 在 macOS 上，如果使用小数显示缩放模式，则返回值不准确。 @@ -3440,7 +5460,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` xxhdpi - 480 dpi xxxhdpi - 640 dpi -\ **注意：**\ 该方法在 Android、Linux（X11/Wayland）、macOS 和 Windows 上实现。在不受支持的平台上返回 ``72``\ 。 +\ **注意：**\ 该方法在 Android、iOS、Linux（X11/Wayland）、macOS、Web、Windows 上实现。该方法在其他平台上始终返回 ``72``\ 。 .. rst-class:: classref-item-separator @@ -3452,11 +5472,13 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Image` **screen_get_image**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回 ``screen`` 的屏幕截图。 +返回屏幕 ``screen`` 的截图。如果 ``screen`` 无效或 **DisplayServer** 无法捕捉到截图，则返回 ``null``\ 。 -\ **注意：**\ 该方法在 Linux（X11）、macOS 和 Windows 上实现。 +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 -\ **注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限，如果未授予权限将返回桌面壁纸颜色。 +\ **注意：**\ 该方法在 Linux（X11，但非 Wayland）、macOS、Windows 上实现。该方法在其他平台上始终返回 ``null``\ 。 + +\ **注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限。如果未授予该权限，则该方法返回的截图中不包含其他应用程序的窗口以及与该应用程序无关的操作系统元素。 .. rst-class:: classref-item-separator @@ -3468,11 +5490,11 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Image` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i`\ ) |const| :ref:`🔗` -返回屏幕上矩形框 ``rect`` 的截图。 +返回由 ``rect`` 定义的屏幕区域的屏幕截图。如果 ``rect`` 超出屏幕边界或 **DisplayServer** 无法捕获屏幕截图，则返回 ``null``\ 。 -\ **注意：**\ 该方法在 macOS 和 Windows 上实现。 +\ ** 注意：**\ 该方法在 macOS 和 Windows 上实现，在其他平台上始终返回 ``null``\ 。 -\ **注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限，如果未授予权限将返回桌面壁纸颜色。 +\ ** 注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限。如果未授予权限，则该方法返回的屏幕截图中将不包含其他应用程序窗口以及与该应用程序无关的操作系统元素。 .. rst-class:: classref-item-separator @@ -3500,9 +5522,11 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`ScreenOrientation` **screen_get_orientation**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回 ``screen`` 的当前朝向。另见 :ref:`screen_set_orientation()`\ 。 +返回屏幕 ``screen`` 的当前朝向。另见 :ref:`screen_set_orientation()`\ 。如果 ``screen`` 无效则返回 :ref:`SCREEN_LANDSCAPE`\ 。 -\ **注意：**\ 该方法在 Android 和 iOS 上实现。 +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 + +\ **注意：**\ 该方法在 Android 和 iOS 上实现。该方法在其他平台上始终返回 :ref:`SCREEN_LANDSCAPE`\ 。 .. rst-class:: classref-item-separator @@ -3516,9 +5540,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 返回 ``position`` 处的显示像素的颜色。 -\ **注意：**\ 该方法在 Linux（X11）、macOS 和 Windows 上实现。 +\ **注意：**\ 该方法在 Linux（X11，排除 XWayland）、macOS 和 Windows 上实现。该方法在其他平台上始终返回 :ref:`Color`\ 。 -\ **注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限，如果未授予权限将返回桌面壁纸颜色。 +\ **注意：**\ 在 macOS 上，该方法需要“屏幕录制”权限，如果未授予权限，则该方法返回的截图中仅包含桌面壁纸、当前应用程序窗口，以及其他相关的 UI 元素。 .. rst-class:: classref-item-separator @@ -3530,7 +5554,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Vector2i` **screen_get_position**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回屏幕左上角的位置，单位为像素。使用多个监视器时，屏幕位置是相对于虚拟桌面区域的位置。如果多监视器中使用了不同的屏幕分辨率或朝向，原点有可能位于所有显示器之外，类似于： +返回屏幕左上角的位置，单位为像素。如果 ``screen`` 无效则返回 :ref:`Vector2i.ZERO`\ 。使用多个监视器时，屏幕位置是相对于虚拟桌面区域的位置。如果多监视器中使用了不同的屏幕分辨率或朝向，原点有可能位于所有显示器之外，类似于： .. code:: text @@ -3541,9 +5565,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` | | | | +-------------+ +-------+ -另见 :ref:`screen_get_size()`\ 。 +另见\ :ref:`screen_get_size()`\ 。 -\ **注意：**\ 在 Linux（Wayland）上，该方法始终返回 ``(0, 0)``\ 。 +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 .. rst-class:: classref-item-separator @@ -3555,11 +5579,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`float` **screen_get_refresh_rate**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回指定屏幕的当前刷新率。如果 ``screen`` 为 :ref:`SCREEN_OF_MAIN_WINDOW`\ （默认值），将使用带有主窗口的屏幕。 +返回指定屏幕的当前刷新率。如果 ``screen`` 无效或 **DisplayServer** 无法查到指定屏幕的刷新率，则返回 ``-1.0``\ 。 -\ **注意：**\ 如果 DisplayServer 未能找到指定屏幕的刷新率，则返回 ``-1.0``\ 。在 Web 上，\ :ref:`screen_get_refresh_rate()` 将始终返回 ``-1.0``\ ，因为无法在该平台上检索到刷新率。 - -要在该方法失败时回退至默认刷新率，请尝试： +要在该方法失败时回退至默认刷新率，可以试一试： :: @@ -3567,6 +5589,10 @@ enum **TTSUtteranceEvent**: :ref:`🔗` if refresh_rate < 0: refresh_rate = 60.0 +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 + +\ **注意：**\ 该方法在 Android、iOS、macOS、Linux（X11 和 Wayland）、Windows 上实现。该方法在其他平台上始终返回 ``-1.0``\ 。 + .. rst-class:: classref-item-separator ---- @@ -3577,13 +5603,15 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`float` **screen_get_scale**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回屏幕的缩放系数，屏幕使用索引号指定。 +返回屏幕的缩放系数，屏幕使用索引号指定。如果 ``screen`` 无效则返回 ``1.0``\ 。 + +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 \ **注意：**\ 在 macOS 上，hiDPI（视网膜）屏幕返回 ``2.0``\ ，其它所有情况均返回 ``1.0``\ 。 \ **注意：**\ 在 Linux（Wayland）上，只有 ``screen`` 为 :ref:`SCREEN_OF_MAIN_WINDOW` 时返回值才是精确的。由于 API 的限制，如果屏幕缩放存在小数点，传入直接的索引号返回的是向上取整后的结果（即 ``1.25`` 会向上取整成 ``2.0``\ ）。 -\ **注意：**\ 该方法在 Android、iOS、Web、macOS 和 Linux（Wayland）上实现。 +\ **注意：**\ 该方法在 Android、iOS、Web、macOS 和 Linux（Wayland）上实现。该方法在其他平台上始终返回 ``1.0``\ 。 .. rst-class:: classref-item-separator @@ -3595,7 +5623,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Vector2i` **screen_get_size**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回屏幕大小。单位：像素。另见 :ref:`screen_get_position()` 和 :ref:`screen_get_usable_rect()`\ 。 +返回屏幕的大小，单位为像素。另见 :ref:`screen_get_position()` 和 :ref:`screen_get_usable_rect()`\ 。如果 ``screen`` 无效则返回 :ref:`Vector2i.ZERO`\ 。 + +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 .. rst-class:: classref-item-separator @@ -3607,7 +5637,11 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`Rect2i` **screen_get_usable_rect**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -返回屏幕上没有被状态栏遮挡的部分，单位为像素。另见 :ref:`screen_get_size()`\ 。 +返回屏幕上未被状态栏遮挡部分。另见 :ref:`screen_get_size()`\ 。 + +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 + +\ **注意：**\ 该方法在 Linux/X11、macOS、Windows 上实现。该方法在其他平台上始终返回 ``Rect2i(screen_get_position(screen), screen_get_size(screen))``\ 。 .. rst-class:: classref-item-separator @@ -3645,7 +5679,25 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 设置 ``screen`` 的 ``orientation``\ 。另见 :ref:`screen_get_orientation()`\ 。 -\ **注意：**\ 在 iOS 上，如果 :ref:`ProjectSettings.display/window/handheld/orientation` 未设置为 :ref:`SCREEN_SENSOR`\ ，则该方法无效。 +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 + +\ **注意：**\ 该方法在 Android 和 iOS 上实现。 + +\ **注意：**\ 在 iOS 上，如果 :ref:`ProjectSettings.display/window/handheld/orientation` 不为 :ref:`SCREEN_SENSOR` 则该方法无效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_set_hardware_keyboard_connection_change_callback: + +.. rst-class:: classref-method + +|void| **set_hardware_keyboard_connection_change_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` + +设置在连接/断开硬件键盘时应调用的 ``callable``\ 。\ ``callable`` 应接受单个 :ref:`bool` 参数，该参数指示键盘是已连接 （true） 还是已断开连接（false）。 + +\ **注意：**\ 该方法仅在 Android 上实现。 .. rst-class:: classref-item-separator @@ -3829,15 +5881,15 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **tablet_set_current_driver**\ (\ name\: :ref:`String`\ ) :ref:`🔗` -设置活动数位板驱动程序名称。 +设置活动平板驱动程序名称。 支持的驱动程序： -- ``winink``\ ：Windows Ink API，默认（需要 Windows 8.1+）。 +- ``winink``\ ：Windows Ink API，默认。 - ``wintab``\ ：Wacom Wintab API（需要兼容的设备驱动程序）。 -- ``dummy``\ ：虚设驱动程序，数位板输入被禁用。 +- ``dummy``\ ：虚设驱动程序，禁用平板输入。 \ **注意：**\ 该方法仅在 Windows 上实现。 @@ -3865,8 +5917,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 这个方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 -\ **注意：**\ :ref:`ProjectSettings.audio/general/text_to_speech` 应当为 ``true`` 才能够使用文本到语音功能。 - .. rst-class:: classref-item-separator ---- @@ -3877,12 +5927,10 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`PackedStringArray` **tts_get_voices_for_language**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` -返回 ``language`` 的语音标识符的 :ref:`PackedStringArray`\ 。 +返回 :ref:`PackedStringArray`\ ，内容为 ``language`` 语言对应的语音标识符。 \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 -\ **注意：**\ :ref:`ProjectSettings.audio/general/text_to_speech` 应为 ``true`` 才能使用文本转语音。 - .. rst-class:: classref-item-separator ---- @@ -3897,8 +5945,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 -\ **注意：**\ :ref:`ProjectSettings.audio/general/text_to_speech` 应为 ``true`` 才能使用文本转语音。 - .. rst-class:: classref-item-separator ---- @@ -3913,8 +5959,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 -\ **注意：**\ :ref:`ProjectSettings.audio/general/text_to_speech` 应为 ``true`` 才能使用文本转语音。 - .. rst-class:: classref-item-separator ---- @@ -3925,11 +5969,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **tts_pause**\ (\ ) :ref:`🔗` -让合成器进入暂停状态。 +将合成器置为暂停状态。 -\ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 以及 Windows 上实现。 - -\ **注意：**\ 要使用文本转语音，\ :ref:`ProjectSettings.audio/general/text_to_speech` 应该为 ``true``\ 。 +\ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 .. rst-class:: classref-item-separator @@ -3941,11 +5983,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **tts_resume**\ (\ ) :ref:`🔗` -让处于暂停状态的合成器继续执行。 +恢复暂停的合成器。 -\ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 以及 Windows 上实现。 - -\ **注意：**\ 要使用文本转语音，\ :ref:`ProjectSettings.audio/general/text_to_speech` 应该为 ``true``\ 。 +\ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 和 Windows 上实现。 .. rst-class:: classref-item-separator @@ -3967,8 +6007,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 以及 Windows 上实现。 -\ **注意：**\ 要使用文本转语音，\ :ref:`ProjectSettings.audio/general/text_to_speech` 应该为 ``true``\ 。 - .. rst-class:: classref-item-separator ---- @@ -3997,8 +6035,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 以及 Windows 上实现。 -\ **注意：**\ 要使用文本转语音，\ :ref:`ProjectSettings.audio/general/text_to_speech` 应该为 ``true``\ 。 - .. rst-class:: classref-item-separator ---- @@ -4013,8 +6049,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Android、iOS、Web、Linux（X11/Wayland）、macOS 以及 Windows 上实现。 -\ **注意：**\ 要使用文本转语音，\ :ref:`ProjectSettings.audio/general/text_to_speech` 应该为 ``true``\ 。 - .. rst-class:: classref-item-separator ---- @@ -4037,7 +6071,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`🔗` -返回键盘在屏幕上的高度，单位为像素。如果没有键盘或当前键盘被隐藏，则返回0。 +返回屏幕键盘的高度（单位为像素）。如果没有键盘或键盘当前被隐藏，则返回 0。 + +\ **注意：**\ 在 Android 7 和 8 上，在非沉浸式模式下首次打开键盘时，键盘高度可能会返回 0。在沉浸式模式下不会出现该行为。 .. rst-class:: classref-item-separator @@ -4137,7 +6173,9 @@ enum **TTSUtteranceEvent**: :ref:`🔗` :ref:`int` **window_get_current_screen**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` -该函数返回窗口 ``window_id`` 所在的屏幕。如果屏幕跨越多个显示器，则返回窗口中心所在的屏幕。另见 :ref:`window_set_current_screen()` 。 +该函数返回窗口 ``window_id`` 所在的屏幕。如果屏幕跨越多个显示器，则返回窗口中心所在的屏幕。另见 :ref:`window_set_current_screen()` 。如果 ``window_id`` 无效则返回 :ref:`INVALID_SCREEN`\ 。 + +\ **注意：**\ 该方法在 Linux/X11、macOS、Windows 上实现。在其他平台上始终返回 ``0``\ 。 .. rst-class:: classref-item-separator @@ -4385,7 +6423,11 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **window_set_current_screen**\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` -将由 ``window_id`` 指定的窗口移动至指定的屏幕 ``screen``\ 。另见 :ref:`window_get_current_screen()`\ 。 +将 ``window_id`` 指定的窗口移动到 ``screen`` 屏幕。另见 :ref:`window_get_current_screen()`\ 。 + +\ **注意：**\ 下列常量可以当作 ``screen`` 使用：\ :ref:`SCREEN_OF_MAIN_WINDOW`\ 、\ :ref:`SCREEN_PRIMARY`\ 、\ :ref:`SCREEN_WITH_MOUSE_FOCUS`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS`\ 。 + +\ **注意：**\ 该方法在 Linux/X11、macOS 和 Windows 上实现。 .. rst-class:: classref-item-separator @@ -4429,7 +6471,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` -启用或禁用给定窗口的给定标志 ``flag``\ 。可能的值和相应的行为见 :ref:`WindowFlags`\ 。 +禁用或启用给定窗口的 ``flag`` 标志。 .. rst-class:: classref-item-separator @@ -4527,7 +6569,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` -将给定窗口的窗口模式设置为 ``mode``\ 。可能的值以及各个模式的行为见 :ref:`WindowMode`\ 。 +将给定窗口的窗口模式设置为 ``mode``\ 。 \ **注意：**\ 在 Android 上，设为 :ref:`WINDOW_MODE_FULLSCREEN` 或 :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN` 会启用沉浸模式。 @@ -4554,10 +6596,10 @@ enum **TTSUtteranceEvent**: :ref:`🔗` # 设置区域，使用 Path2D 节点。 DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points()) - + # 设置区域，使用 Polygon2D 节点。 DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon) - + # 重置区域为默认值。 DisplayServer.window_set_mouse_passthrough([]) @@ -4565,10 +6607,10 @@ enum **TTSUtteranceEvent**: :ref:`🔗` // 设置区域，使用 Path2D 节点。 DisplayServer.WindowSetMousePassthrough(GetNode("Path2D").Curve.GetBakedPoints()); - + // 设置区域，使用 Polygon2D 节点。 DisplayServer.WindowSetMousePassthrough(GetNode("Polygon2D").Polygon); - + // 重置区域为默认值。 DisplayServer.WindowSetMousePassthrough([]); @@ -4689,8 +6731,6 @@ enum **TTSUtteranceEvent**: :ref:`🔗` 设置给定窗口的垂直同步模式。另见 :ref:`ProjectSettings.display/window/vsync/vsync_mode`\ 。 -参阅 :ref:`VSyncMode` 了解可能的值，以及它们如何影响应用程序的行为。 - 根据平台和使用的渲染器，如果不支持所需的模式，引擎将回退到 :ref:`VSYNC_ENABLED`\ 。 \ **注意：**\ 除 :ref:`VSYNC_ENABLED` 以外的垂直同步模式，仅支持 Forward+ 和 Mobile 渲染方式，不支持 Compatibility。 @@ -4752,6 +6792,7 @@ enum **TTSUtteranceEvent**: :ref:`🔗` \ **注意：**\ 该方法在 Linux（X11/Wayland）、macOS 和 Windows 上实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_dpitexture.rst b/classes/zh_CN/class_dpitexture.rst new file mode 100644 index 0000000000..3151da2442 --- /dev/null +++ b/classes/zh_CN/class_dpitexture.rst @@ -0,0 +1,193 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DPITexture.xml. + +.. _class_DPITexture: + +DPITexture +========== + +**实验性：** This class may be changed or removed in future versions. + +**继承：** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +An automatically scalable :ref:`Texture2D` based on an SVG image. + +.. rst-class:: classref-introduction-group + +描述 +---- + +An automatically scalable :ref:`Texture2D` based on an SVG image. **DPITexture**\ s are used to automatically re-rasterize icons and other texture based UI theme elements to match viewport scale and font oversampling. See also :ref:`ProjectSettings.display/window/stretch/mode` ("canvas_items" mode) and :ref:`Viewport.oversampling_override`. + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`base_scale` | ``1.0`` | + +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`color_map` | ``{}`` | + +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | + +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`saturation` | ``1.0`` | + +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`DPITexture` | :ref:`create_from_string`\ (\ source\: :ref:`String`, scale\: :ref:`float` = 1.0, saturation\: :ref:`float` = 1.0, color_map\: :ref:`Dictionary` = {}\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_scaled_rid`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_source`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_size_override`\ (\ size\: :ref:`Vector2i`\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_source`\ (\ source\: :ref:`String`\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_DPITexture_property_base_scale: + +.. rst-class:: classref-property + +:ref:`float` **base_scale** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_base_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_base_scale**\ (\ ) + +Texture scale. ``1.0`` is the original SVG size. Higher values result in a larger image. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_property_color_map: + +.. rst-class:: classref-property + +:ref:`Dictionary` **color_map** = ``{}`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_color_map**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_color_map**\ (\ ) + +If set, remaps texture colors according to :ref:`Color`-:ref:`Color` map. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_property_saturation: + +.. rst-class:: classref-property + +:ref:`float` **saturation** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_saturation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_saturation**\ (\ ) + +覆盖纹理饱和度。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_DPITexture_method_create_from_string: + +.. rst-class:: classref-method + +:ref:`DPITexture` **create_from_string**\ (\ source\: :ref:`String`, scale\: :ref:`float` = 1.0, saturation\: :ref:`float` = 1.0, color_map\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` + +Creates a new **DPITexture** and initializes it by allocating and setting the SVG data from string. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_method_get_scaled_rid: + +.. rst-class:: classref-method + +:ref:`RID` **get_scaled_rid**\ (\ ) |const| :ref:`🔗` + +Returns the :ref:`RID` of the texture rasterized to match the oversampling of the currently drawn canvas item. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_method_get_source: + +.. rst-class:: classref-method + +:ref:`String` **get_source**\ (\ ) |const| :ref:`🔗` + +返回 SVG 源代码。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_method_set_size_override: + +.. rst-class:: classref-method + +|void| **set_size_override**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` + +将纹理的大小调整为指定的尺寸。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_DPITexture_method_set_source: + +.. rst-class:: classref-method + +|void| **set_source**\ (\ source\: :ref:`String`\ ) :ref:`🔗` + +设置 SVG 源代码。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_dtlsserver.rst b/classes/zh_CN/class_dtlsserver.rst index 2151000758..23c31f06be 100644 --- a/classes/zh_CN/class_dtlsserver.rst +++ b/classes/zh_CN/class_dtlsserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/DTLSServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DTLSServer.xml. .. _class_DTLSServer: @@ -30,17 +30,17 @@ DTLSServer # server_node.gd extends Node - + var dtls = DTLSServer.new() var server = UDPServer.new() var peers = [] - + func _ready(): server.listen(4242) var key = load("key.key") # 你的私钥。 var cert = load("cert.crt") # 你的 X509 证书。 dtls.setup(TlsOptions.server(key, cert)) - + func _process(delta): while server.is_connection_available(): var peer = server.take_connection() @@ -49,7 +49,7 @@ DTLSServer continue # 由于 cookie 交换，50% 的连接会失败，这是正常现象。 print("对等体已连接！") peers.append(dtls_peer) - + for p in peers: p.poll() # 必须轮询以更新状态。 if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED: @@ -61,13 +61,13 @@ DTLSServer // ServerNode.cs using Godot; - + public partial class ServerNode : Node { private DtlsServer _dtls = new DtlsServer(); private UdpServer _server = new UdpServer(); private Godot.Collections.Array _peers = []; - + public override void _Ready() { _server.Listen(4242); @@ -75,7 +75,7 @@ DTLSServer var cert = GD.Load("cert.crt"); // 你的 X509 证书。 _dtls.Setup(TlsOptions.Server(key, cert)); } - + public override void _Process(double delta) { while (_server.IsConnectionAvailable()) @@ -89,7 +89,7 @@ DTLSServer GD.Print("对等体已连接！"); _peers.Add(dtlsPeer); } - + foreach (var p in _peers) { p.Poll(); // 必须轮询以更新状态。 @@ -114,15 +114,15 @@ DTLSServer # client_node.gd extends Node - + var dtls = PacketPeerDTLS.new() var udp = PacketPeerUDP.new() var connected = false - + func _ready(): udp.connect_to_host("127.0.0.1", 4242) dtls.connect_to_peer(udp, false) # 生产环境中请使用 true 进行证书校验！ - + func _process(delta): dtls.poll() if dtls.get_status() == PacketPeerDTLS.STATUS_CONNECTED: @@ -138,19 +138,19 @@ DTLSServer // ClientNode.cs using Godot; using System.Text; - + public partial class ClientNode : Node { private PacketPeerDtls _dtls = new PacketPeerDtls(); private PacketPeerUdp _udp = new PacketPeerUdp(); private bool _connected = false; - + public override void _Ready() { _udp.ConnectToHost("127.0.0.1", 4242); _dtls.ConnectToPeer(_udp, validateCerts: false); // 生产环境中请使用 true 进行证书校验！ } - + public override void _Process(double delta) { _dtls.Poll(); @@ -218,6 +218,7 @@ DTLSServer \ **注意：**\ 必须检查返回的 PacketPeerUDP 的状态是否为 :ref:`PacketPeerDTLS.STATUS_HANDSHAKING`\ ，因为正常情况下，50% 的新连接会因为 cookie 交换而无效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorcommandpalette.rst b/classes/zh_CN/class_editorcommandpalette.rst index 78130bac92..d190637230 100644 --- a/classes/zh_CN/class_editorcommandpalette.rst +++ b/classes/zh_CN/class_editorcommandpalette.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorCommandPalette.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorCommandPalette.xml. .. _class_EditorCommandPalette: @@ -110,6 +110,7 @@ Godot 编辑器的命令面板。 - ``key_name``: :ref:`String` (特定 **Command** 的键名) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorcontextmenuplugin.rst b/classes/zh_CN/class_editorcontextmenuplugin.rst index 1bdeb1174c..1830bc112a 100644 --- a/classes/zh_CN/class_editorcontextmenuplugin.rst +++ b/classes/zh_CN/class_editorcontextmenuplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorContextMenuPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorContextMenuPlugin.xml. .. _class_EditorContextMenuPlugin: @@ -88,7 +88,15 @@ enum **ContextMenuSlot**: :ref:`🔗` **CONTEXT_SLOT_FILESYSTEM_CREATE** = ``3`` -“文件系统”面板上下文菜单的“创建...”子菜单。调用 :ref:`_popup_menu()` 和可选回调时提供的是当前所选文件路径的列表。 +“文件系统”面板上下文菜单的“创建...”子菜单，或是点击空白位置的主上下文菜单中的“新建”部分。调用 :ref:`_popup_menu()` 和可选回调时提供的是当前所选文件夹的路径。点击空白区域时，为弹出方法提供的路径列表为空。 + +:: + + func _popup_menu(paths): + if paths.is_empty(): + add_context_menu_item("新建图像文件...", create_image) + else: + add_context_menu_item("图像文件...", create_image) .. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR_CODE: @@ -180,7 +188,7 @@ enum **ContextMenuSlot**: :ref:`🔗` 检查它们的状态。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editordebuggersession.rst b/classes/zh_CN/class_editordebuggersession.rst index ed9cd72d2d..c37685f6d1 100644 --- a/classes/zh_CN/class_editordebuggersession.rst +++ b/classes/zh_CN/class_editordebuggersession.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorDebuggerSession.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorDebuggerSession.xml. .. _class_EditorDebuggerSession: @@ -204,6 +204,7 @@ EditorDebuggerSession 在所附加的远程实例上开关给定的 ``profiler``\ ，还可以传入额外的数据 ``data``\ 。详见 :ref:`EngineProfiler`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatform.rst b/classes/zh_CN/class_editorexportplatform.rst index 9a1381119a..edb1a348bc 100644 --- a/classes/zh_CN/class_editorexportplatform.rst +++ b/classes/zh_CN/class_editorexportplatform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorExportPlatform.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatform.xml. .. _class_EditorExportPlatform: @@ -12,7 +12,7 @@ EditorExportPlatform **继承：** :ref:`RefCounted` **<** :ref:`Object` -**派生：** :ref:`EditorExportPlatformAndroid`, :ref:`EditorExportPlatformExtension`, :ref:`EditorExportPlatformIOS`, :ref:`EditorExportPlatformMacOS`, :ref:`EditorExportPlatformPC`, :ref:`EditorExportPlatformWeb` +**派生：** :ref:`EditorExportPlatformAndroid`, :ref:`EditorExportPlatformAppleEmbedded`, :ref:`EditorExportPlatformExtension`, :ref:`EditorExportPlatformMacOS`, :ref:`EditorExportPlatformPC`, :ref:`EditorExportPlatformWeb` 标识一个支持的导出平台，并在内部提供导出到该平台的功能。 @@ -65,7 +65,7 @@ EditorExportPlatform +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_current_presets`\ (\ ) |const| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_forced_export_files`\ (\ ) |static| | + | :ref:`PackedStringArray` | :ref:`get_forced_export_files`\ (\ preset\: :ref:`EditorExportPreset` = null\ ) |static| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_internal_export_files`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -159,7 +159,7 @@ flags **DebugFlags**: :ref:`🔗` :ref:`DebugFlags` **DEBUG_FLAG_DUMB_CLIENT** = ``1`` -如果希望远程调试的项目使用远程文件系统，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--remote-fs`` 和 ``--remote-fs-password``\ （如果在编辑器设置中设置了密码）命令行参数添加到列表中。 +如果希望远程调试的项目使用远程文件系统，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--remote-fs`` 和 ``--remote-fs-password``\ （如果定义了 :ref:`EditorSettings.filesystem/file_server/password`\ ）命令行参数追加到返回的列表中。 .. _class_EditorExportPlatform_constant_DEBUG_FLAG_REMOTE_DEBUG: @@ -167,7 +167,7 @@ flags **DebugFlags**: :ref:`🔗` :ref:`DebugFlags` **DEBUG_FLAG_REMOTE_DEBUG** = ``2`` -如果启用了远程调试，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--remote-debug`` 和 ``--breakpoints``\ （如果脚本编辑器中选择了断点或插件添加了断点）命令行参数添加到列表中。 +如果启用了远程调试，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--remote-debug`` 和 ``--breakpoints``\ （如果脚本编辑器中选择了断点或插件添加了断点）命令行参数追加到返回的列表中。 .. _class_EditorExportPlatform_constant_DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST: @@ -183,7 +183,7 @@ flags **DebugFlags**: :ref:`🔗` :ref:`DebugFlags` **DEBUG_FLAG_VIEW_COLLISIONS** = ``8`` -如果启用了“显示碰撞形状”远程调试选项，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--debug-collisions`` 命令行参数添加到列表中。 +如果启用了“显示碰撞形状”远程调试选项，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--debug-collisions`` 命令行参数追加到返回的列表中。 .. _class_EditorExportPlatform_constant_DEBUG_FLAG_VIEW_NAVIGATION: @@ -191,7 +191,7 @@ flags **DebugFlags**: :ref:`🔗` :ref:`DebugFlags` **DEBUG_FLAG_VIEW_NAVIGATION** = ``16`` -如果启用了“显示导航”远程调试选项，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--debug-navigation`` 命令行参数添加到列表中。 +如果启用了“显示导航”远程调试选项，则设置该标志。如果设置了该标志，则 :ref:`gen_export_flags()` 会将 ``--debug-navigation`` 命令行参数追加到返回的列表中。 .. rst-class:: classref-section-separator @@ -360,7 +360,7 @@ flags **DebugFlags**: :ref:`🔗` .. rst-class:: classref-method -:ref:`PackedStringArray` **get_forced_export_files**\ (\ ) |static| :ref:`🔗` +:ref:`PackedStringArray` **get_forced_export_files**\ (\ preset\: :ref:`EditorExportPreset` = null\ ) |static| :ref:`🔗` 返回核心文件名数组，这些文件无论预设配置如何都应该导出。 @@ -535,6 +535,7 @@ flags **DebugFlags**: :ref:`🔗` 通过 SSH 协议在远程主机上执行指定的命令，返回（远程主机上的）进程 ID，无需等待命令完成。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformandroid.rst b/classes/zh_CN/class_editorexportplatformandroid.rst index b1d0e08d1c..6ab0498c33 100644 --- a/classes/zh_CN/class_editorexportplatformandroid.rst +++ b/classes/zh_CN/class_editorexportplatformandroid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/android/doc_classes/EditorExportPlatformAndroid.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/android/doc_classes/EditorExportPlatformAndroid.xml. .. _class_EditorExportPlatformAndroid: @@ -60,6 +60,8 @@ Android 导出器。 +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gradle_build/compress_native_libraries` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`gradle_build/custom_theme_attributes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gradle_build/export_format` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`gradle_build/gradle_build_directory` | @@ -416,6 +418,10 @@ Android 导出器。 +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/write_user_dictionary` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`screen/background_color` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/edge_to_edge` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`screen/immersive_mode` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`screen/support_large` | @@ -426,6 +432,8 @@ Android 导出器。 +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`screen/support_xlarge` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`user_data_backup/allow` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`version/code` | @@ -604,9 +612,29 @@ Android 导出器。 :ref:`bool` **gradle_build/compress_native_libraries** :ref:`🔗` -如果为 ``true``\ ，则在执行 Gradle 构建时会压缩原生库。 +If ``true``, native libraries are compressed when performing a Gradle build. -\ **注意：**\ 虽然你的二进制文件可能较小，但你的应用程序仍可能加载速度较慢，因为原生库在运行时不是直接从二进制文件加载的。 +\ **Note:** While enabling compression can reduce the size of the binary, it may result in slower application startup because the native libraries must be extracted before use, rather than being loaded directly. + +If you're distributing your app via the Play Store, it's generally recommended to keep this option ``false``, see `official documentation `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_gradle_build/custom_theme_attributes: + +.. rst-class:: classref-property + +:ref:`Dictionary` **gradle_build/custom_theme_attributes** :ref:`🔗` + +要包含在导出的 Android 项目中的自定义主题属性的字典。每个条目都定义了一个主题属性名称及其值，并将添加到 **GodotAppMainTheme** 中。 + +例如，值为 ``false`` 的键 ``android:windowSwipeToDismiss`` 被解析为 ``false``\ 。 + +\ **注意：**\ 要向 **GodotAppSplashTheme** 添加自定义属性，请在属性名称前加上 ``[splash]``\ 。 + +\ **注意：**\ 通过其他导出选项或项目设置配置的保留属性不能被 ``custom_theme_attributes`` 覆盖，并且在导出过程中会被跳过。 .. rst-class:: classref-item-separator @@ -2608,7 +2636,7 @@ WallpaperService 必须要求此权限，确保只能系统能够进行绑定。 :ref:`bool` **permissions/wake_lock** :ref:`🔗` -允许使用 PowerManager WakeLock 放置处理器进入休眠或屏幕变暗。见 `WAKE_LOCK `__\ 。 +允许使用 PowerManager WakeLock 防止处理器进入休眠或屏幕变暗。见 `WAKE_LOCK `__\ 。 .. rst-class:: classref-item-separator @@ -2782,13 +2810,39 @@ WallpaperService 必须要求此权限，确保只能系统能够进行绑定。 ---- +.. _class_EditorExportPlatformAndroid_property_screen/background_color: + +.. rst-class:: classref-property + +:ref:`Color` **screen/background_color** :ref:`🔗` + +根窗口使用的背景颜色。默认为 ``black``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/edge_to_edge: + +.. rst-class:: classref-property + +:ref:`bool` **screen/edge_to_edge** :ref:`🔗` + +如果为 ``true``\ ，则导航栏和状态栏将变为半透明，并允许应用程序内容从一边延伸到另一边。 + +\ **注意：**\ 你应该使用 :ref:`DisplayServer.get_display_safe_area()` 和 :ref:`DisplayServer.get_display_cutouts()` 方法，以确保应用程序的内容不会被系统元素遮挡。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_screen/immersive_mode: .. rst-class:: classref-property :ref:`bool` **screen/immersive_mode** :ref:`🔗` -如果为 ``true``\ ，则隐藏导航栏及状态栏。运行时开关见 :ref:`DisplayServer.window_set_mode()`\ 。 +如果为 ``true`` 则隐藏导航栏及状态栏。运行时更改请设置 :ref:`DisplayServer.window_set_mode()`\ 。 .. rst-class:: classref-item-separator @@ -2842,6 +2896,18 @@ WallpaperService 必须要求此权限，确保只能系统能够进行绑定。 ---- +.. _class_EditorExportPlatformAndroid_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则着色器将被编译并嵌入到应用程序中。仅当使用 Forward+ 或 Mobile 渲染器时，才支持此选项。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_user_data_backup/allow: .. rst-class:: classref-property @@ -2887,6 +2953,7 @@ WallpaperService 必须要求此权限，确保只能系统能够进行绑定。 应用程序的扩展现实（XR）模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformappleembedded.rst b/classes/zh_CN/class_editorexportplatformappleembedded.rst new file mode 100644 index 0000000000..d2855b1ba8 --- /dev/null +++ b/classes/zh_CN/class_editorexportplatformappleembedded.rst @@ -0,0 +1,43 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformAppleEmbedded.xml. + +.. _class_EditorExportPlatformAppleEmbedded: + +EditorExportPlatformAppleEmbedded +================================= + +**继承：** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +**派生：** :ref:`EditorExportPlatformIOS`, :ref:`EditorExportPlatformVisionOS` + +Apple 嵌入式平台导出器的基类（iOS 与 visionOS）。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +Apple 嵌入式平台导出器的基类。包括 iOS 和 visionOS，但是不包括 macOS。详见派生类。 + +.. rst-class:: classref-introduction-group + +教程 +---- + +- :doc:`为 iOS 导出 <../tutorials/export/exporting_for_ios>` + +- :doc:`iOS 插件文档索引 <../tutorials/platform/ios/index>` + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_editorexportplatformextension.rst b/classes/zh_CN/class_editorexportplatformextension.rst index cb858862ff..bfa55e08a2 100644 --- a/classes/zh_CN/class_editorexportplatformextension.rst +++ b/classes/zh_CN/class_editorexportplatformextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorExportPlatformExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformExtension.xml. .. _class_EditorExportPlatformExtension: @@ -40,13 +40,13 @@ EditorExportPlatformExtension +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_pack_patch`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_export_project`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | + | :ref:`Error` | :ref:`_export_project`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| |required| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_zip`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_zip_patch`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_binary_extensions`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| | + | :ref:`PackedStringArray` | :ref:`_get_binary_extensions`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_debug_protocol`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,11 +58,11 @@ EditorExportPlatformExtension +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_export_options`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`_get_logo`\ (\ ) |virtual| |const| | + | :ref:`Texture2D` | :ref:`_get_logo`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ImageTexture` | :ref:`_get_option_icon`\ (\ device\: :ref:`int`\ ) |virtual| |const| | + | :ref:`Texture2D` | :ref:`_get_option_icon`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_option_label`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,17 +72,17 @@ EditorExportPlatformExtension +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_options_tooltip`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_os_name`\ (\ ) |virtual| |const| | + | :ref:`String` | :ref:`_get_os_name`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_platform_features`\ (\ ) |virtual| |const| | + | :ref:`PackedStringArray` | :ref:`_get_platform_features`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_preset_features`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| | + | :ref:`PackedStringArray` | :ref:`_get_preset_features`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`_get_run_icon`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_valid_export_configuration`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| | + | :ref:`bool` | :ref:`_has_valid_export_configuration`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_valid_project_configuration`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| | + | :ref:`bool` | :ref:`_has_valid_project_configuration`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_executable`\ (\ path\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,8 +116,6 @@ EditorExportPlatformExtension :ref:`bool` **_can_export**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果 ``preset`` 预设有效且能够导出，则返回 ``true``\ 。请使用 :ref:`set_config_error()` 和 :ref:`set_config_missing_templates()` 设置错误细节。 通常的实现可以调用 :ref:`_has_valid_export_configuration()` 和 :ref:`_has_valid_project_configuration()` 来确定是否可以进行导出。 @@ -132,8 +130,6 @@ EditorExportPlatformExtension |void| **_cleanup**\ (\ ) |virtual| :ref:`🔗` -**可选。**\ - 注销平台前编辑器会调用该方法。 .. rst-class:: classref-item-separator @@ -146,8 +142,6 @@ EditorExportPlatformExtension :ref:`Error` **_export_pack**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 使用 ``preset`` 预设在 ``path`` 路径处创建 PCK 包。 在导出对话框中按下“导出 PCK/ZIP”按钮，禁用“导出为补丁”，并选择 PCK 作为文件类型时，将调用该方法。 @@ -162,8 +156,6 @@ EditorExportPlatformExtension :ref:`Error` **_export_pack_patch**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 使用 ``preset`` 预设在路径 ``path`` 处创建补丁 PCK 归档，包含自上次补丁以来发生更改的文件。 在导出对话框中按下“导出 PCK/ZIP”按钮，启用“导出为补丁”，并选择 PCK 作为文件类型时，将调用该方法。 @@ -178,9 +170,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`Error` **_export_project**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`Error` **_export_project**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| |required| :ref:`🔗` 使用 ``preset`` 预设在 ``path`` 路径处创建完整的项目。 @@ -198,8 +188,6 @@ EditorExportPlatformExtension :ref:`Error` **_export_zip**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 使用 ``preset`` 预设在 ``path`` 路径处创建 ZIP 归档。 在导出对话框中按下“导出 PCK/ZIP”按钮，禁用“导出为补丁”，并选择 ZIP 作为文件类型时，将调用该方法。 @@ -214,8 +202,6 @@ EditorExportPlatformExtension :ref:`Error` **_export_zip_patch**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 使用 ``preset`` 预设在 ``path`` 路径处创建 ZIP 归档，仅包含自上次补丁以来发生更改的文件。 在导出对话框中按下“导出 PCK/ZIP”按钮，启用“导出为补丁”，并选择 ZIP 作为文件类型时，将调用该方法。 @@ -230,9 +216,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_binary_extensions**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`PackedStringArray` **_get_binary_extensions**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` 返回完整项目导出所支持的二进制文件扩展名数组。 @@ -246,8 +230,6 @@ EditorExportPlatformExtension :ref:`String` **_get_debug_protocol**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回用于远程调试的协议。默认实现返回 ``tcp://``\ 。 .. rst-class:: classref-item-separator @@ -260,8 +242,6 @@ EditorExportPlatformExtension :ref:`String` **_get_device_architecture**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回一键部署的设备架构。 .. rst-class:: classref-item-separator @@ -274,8 +254,6 @@ EditorExportPlatformExtension :ref:`bool` **_get_export_option_visibility**\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 验证 ``option`` 并返回指定 ``preset`` 的可见性。默认实现为所有选项都返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -288,8 +266,6 @@ EditorExportPlatformExtension :ref:`String` **_get_export_option_warning**\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 验证 ``option`` 并返回指定 ``preset`` 的警告消息。默认实现为所有选项都返回空字符串。 .. rst-class:: classref-item-separator @@ -302,8 +278,6 @@ EditorExportPlatformExtension :ref:`Array`\[:ref:`Dictionary`\] **_get_export_options**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回属性列表，类型是元素为字典的 :ref:`Array`\ 。每个 :ref:`Dictionary` 都必须至少包含 ``name: StringName`` 和 ``type: Variant.Type`` 两个条目。 另外还支持如下字段： @@ -332,11 +306,9 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`Texture2D` **_get_logo**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Texture2D` **_get_logo**\ (\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回导出对话框中显示的平台徽标，徽标应为 32x32，根据当前编辑器缩放调整，见 :ref:`EditorInterface.get_editor_scale()`\ 。 +返回导出对话框中显示的平台徽标，该徽标应为 32×32 像素，并根据当前编辑器的缩放进行调整（见 :ref:`EditorInterface.get_editor_scale()`\ ）。 .. rst-class:: classref-item-separator @@ -346,9 +318,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`String` **_get_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回导出平台的名称。 @@ -360,11 +330,9 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`ImageTexture` **_get_option_icon**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Texture2D` **_get_option_icon**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回 ``device`` 设备的一键部署菜单项图标，该图标应为 16x16，根据当前编辑器缩放调整，见 :ref:`EditorInterface.get_editor_scale()`\ 。 +返回一键部署菜单中指定 ``device`` 设备的条目图标。该图标应为 16×16 像素，并根据当前编辑器的缩放进行调整（见 :ref:`EditorInterface.get_editor_scale()`\ ）。 .. rst-class:: classref-item-separator @@ -376,8 +344,6 @@ EditorExportPlatformExtension :ref:`String` **_get_option_label**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 ``device`` 设备的一键部署菜单项标签。 .. rst-class:: classref-item-separator @@ -390,8 +356,6 @@ EditorExportPlatformExtension :ref:`String` **_get_option_tooltip**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 ``device`` 设备的一键部署菜单项工具提示。 .. rst-class:: classref-item-separator @@ -404,9 +368,7 @@ EditorExportPlatformExtension :ref:`int` **_get_options_count**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回一键部署设备（或菜单中显示的其他一键部署选项）的数量。 +返回一键部署菜单中可用的设备（或其他选项）的数量。 .. rst-class:: classref-item-separator @@ -418,8 +380,6 @@ EditorExportPlatformExtension :ref:`String` **_get_options_tooltip**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回一键部署菜单按钮的工具提示。 .. rst-class:: classref-item-separator @@ -430,9 +390,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`String` **_get_os_name**\ (\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`String` **_get_os_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回目标操作系统的名称。 @@ -444,9 +402,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_platform_features**\ (\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`PackedStringArray` **_get_platform_features**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回平台特定功能的数组。 @@ -458,9 +414,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_preset_features**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`PackedStringArray` **_get_preset_features**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` 返回 ``preset`` 预设对应的平台特定功能的数组。 @@ -474,9 +428,7 @@ EditorExportPlatformExtension :ref:`Texture2D` **_get_run_icon**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回一键部署菜单按钮的图标，该图标应为 16x16，根据当前编辑器缩放调整，见 :ref:`EditorInterface.get_editor_scale()`\ 。 +返回一键部署菜单按钮的图标。该图标应为 16×16 像素，并根据当前编辑器缩放进行调整（见 :ref:`EditorInterface.get_editor_scale()`\ ）。 .. rst-class:: classref-item-separator @@ -486,9 +438,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`bool` **_has_valid_export_configuration**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_has_valid_export_configuration**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |required| |const| :ref:`🔗` 如果导出配置有效，则返回 ``true``\ 。 @@ -500,9 +450,7 @@ EditorExportPlatformExtension .. rst-class:: classref-method -:ref:`bool` **_has_valid_project_configuration**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_has_valid_project_configuration**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` 如果项目配置有效，则返回 ``true``\ 。 @@ -516,8 +464,6 @@ EditorExportPlatformExtension :ref:`bool` **_is_executable**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果指定的文件是目标平台上的有效可执行文件（原生可执行文件或脚本），则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -530,8 +476,6 @@ EditorExportPlatformExtension :ref:`bool` **_poll_export**\ (\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果一键部署选项发生更改，编辑器界面需要更新，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -544,8 +488,6 @@ EditorExportPlatformExtension :ref:`Error` **_run**\ (\ preset\: :ref:`EditorExportPreset`, device\: :ref:`int`, debug_flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 选择 ``device`` 一键部署菜单选项时调用该方法。 实现时应当将项目导出到临时位置，然后将其上传至 ``device`` 设备并运行，也可以执行与该菜单项相关的其他动作。 @@ -560,8 +502,6 @@ EditorExportPlatformExtension :ref:`bool` **_should_update_export_options**\ (\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果导出选项列表发生了更改，应当更新预设，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -613,6 +553,7 @@ EditorExportPlatformExtension 设为 ``true`` 表示当前配置缺失导出模板 。该方法只应在 :ref:`_can_export()`\ 、\ :ref:`_has_valid_export_configuration()`\ 、\ :ref:`_has_valid_project_configuration()` 的实现中调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformios.rst b/classes/zh_CN/class_editorexportplatformios.rst index c785fa0dda..b42e109a92 100644 --- a/classes/zh_CN/class_editorexportplatformios.rst +++ b/classes/zh_CN/class_editorexportplatformios.rst @@ -2,15 +2,15 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/ios/doc_classes/EditorExportPlatformIOS.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/ios/doc_classes/EditorExportPlatformIOS.xml. .. _class_EditorExportPlatformIOS: EditorExportPlatformIOS ======================= -**继承：** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` +**继承：** :ref:`EditorExportPlatformAppleEmbedded` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` iOS 导出器。 @@ -500,6 +500,8 @@ iOS 导出器。 +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`privacy/user_defaults_access_reasons` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`storyboard/custom_bg_color` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`storyboard/custom_image@2x` | @@ -571,7 +573,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/code_sign_identity_debug** :ref:`🔗` -用于调试导出的签名身份的“全名”、“通用名”或 SHA-1 哈希值。 +用于调试导出的签名身份的“全名”“通用名”或 SHA-1 哈希值。 .. rst-class:: classref-item-separator @@ -583,7 +585,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/code_sign_identity_release** :ref:`🔗` -用于发布导出的签名身份的“全名”、“通用名”或 SHA-1 哈希值。 +用于发布导出的签名身份的“全名”“通用名”或 SHA-1 哈希值。 .. rst-class:: classref-item-separator @@ -667,9 +669,9 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/provisioning_profile_specifier_debug** :ref:`🔗` -预置描述文件的名称。设置调试时 XCode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 +预置描述文件的名称。设置调试时 Xcode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 -可以使用环境变量 ``GODOT_IOS_PROFILE_SPECIFIER_DEBUG`` 覆盖。 +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_DEBUG`` 覆盖。 .. rst-class:: classref-item-separator @@ -681,9 +683,9 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/provisioning_profile_specifier_release** :ref:`🔗` -预置描述文件的名称。设置发布时 XCode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 +预置描述文件的名称。设置发布时 Xcode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 -可以使用环境变量 ``GODOT_IOS_PROFILE_SPECIFIER_RELEASE`` 覆盖。 +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_RELEASE`` 覆盖。 .. rst-class:: classref-item-separator @@ -697,7 +699,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， 预置描述文件的 UUID。如果留空，则 Xcode 会自动下载或创建一个预置描述文件。见\ `编辑、下载或删除预置描述文件 `__\ 。 -可以使用环境变量 ``GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG`` 覆盖。 +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_DEBUG`` 覆盖。 .. rst-class:: classref-item-separator @@ -711,7 +713,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， 预置描述文件的 UUID。如果留空，则 Xcode 会自动下载或创建一个预置描述文件。见\ `编辑、下载或删除预置描述文件 `__\ 。 -可以使用环境变量 ``GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE`` 覆盖。 +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE`` 覆盖。 .. rst-class:: classref-item-separator @@ -723,7 +725,9 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/short_version** :ref:`🔗` -用户可见的应用程序版本，只能包含数字字符（\ ``0-9``\ ）和句点（\ ``.``\ ）。如果留空，则回退到 :ref:`ProjectSettings.application/config/version`\ 。 +Application version visible to the user. Can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Version* value in the generated Xcode project. .. rst-class:: classref-item-separator @@ -759,7 +763,9 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`String` **application/version** :ref:`🔗` -机器可读的应用程序版本，采用 ``major.minor.patch`` 格式，只能包含数字字符（\ ``0-9``\ ）和句点（\ ``.``\ ）。该值必须在被推送到 App Store 的每个新版本中递增。 +Machine-readable application version in the ``major.minor.patch`` format. Can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented with every new release pushed to the App Store. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Build* value in the generated Xcode project. .. rst-class:: classref-item-separator @@ -878,7 +884,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`bool` **entitlements/game_center** :ref:`🔗` -启用后允许访问 Game Center 功能。\ `com.apple.developer.game-center `__\ 。 +如果为 ``true``\ ，则会允许访问 Game Center 功能。见 `com.apple.developer.game-center `__\ 。 .. rst-class:: classref-item-separator @@ -890,7 +896,7 @@ Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID， :ref:`bool` **entitlements/increased_memory_limit** :ref:`🔗` -如果应用在更高的内存限制下可能表现更好，请启用该选项。\ `com.apple.developer.kernel.increased-memory-limit `__\ 。 +如果为 ``true``\ ，则提示该应用在更高的内存限制下可能表现更好。见 `com.apple.developer.kernel.increased-memory-limit `__\ 。 .. rst-class:: classref-item-separator @@ -3358,6 +3364,18 @@ iPad 和 iPhone 上的“聚焦”图标文件（3x DPI），着色版本。见 ---- +.. _class_EditorExportPlatformIOS_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则着色器将被编译并嵌入到应用程序中。仅当使用 Forward+ 或 Mobile 渲染器时，才支持此选项。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color: .. rst-class:: classref-property @@ -3439,6 +3457,7 @@ Storyboard 启动屏幕的自定义背景色。 如果为 ``true``\ ，应用的“Documents”文件夹可以在 iTunes 文件共享中访问。见 `UIFileSharingEnabled `__\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformlinuxbsd.rst b/classes/zh_CN/class_editorexportplatformlinuxbsd.rst index bfe8b4ec3c..2297755a10 100644 --- a/classes/zh_CN/class_editorexportplatformlinuxbsd.rst +++ b/classes/zh_CN/class_editorexportplatformlinuxbsd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. .. _class_EditorExportPlatformLinuxBSD: @@ -40,6 +40,8 @@ Linux/BSD 导出器。 +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/export_console_wrapper` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | @@ -76,7 +78,7 @@ Linux/BSD 导出器。 程序可执行文件架构。 -支持的架构有：\ ``x86_32``\ 、\ ``x86_64``\ 、\ ``arm64``\ 、\ ``arm32``\ 、\ ``rv64``\ 、\ ``ppc64``\ 、\ ``ppc32``\ 、\ ``loongarch64``\ 。 +支持的架构有：\ ``x86_32``\ 、\ ``x86_64``\ 、\ ``arm64``\ 、\ ``arm32``\ 、\ ``rv64``\ 、\ ``ppc64``\ 、\ ``loongarch64``\ 。 官方导出模板中仅包含 ``x86_32``\ 、\ ``x86_64``\ 、\ ``arm32``\ 、\ ``arm64`` 的二进制文件。 @@ -132,6 +134,18 @@ Linux/BSD 导出器。 ---- +.. _class_EditorExportPlatformLinuxBSD_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则着色器将被编译并嵌入到应用程序中。仅当使用 Forward+ 或 Mobile 渲染器时，才支持此选项。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/cleanup_script: .. rst-class:: classref-property @@ -257,6 +271,7 @@ Linux/BSD 导出器。 如果为 ``true``\ ，则项目中的纹理在导出时使用 S3TC/BPTC 格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformmacos.rst b/classes/zh_CN/class_editorexportplatformmacos.rst index 35c0a86caf..8c4173d98c 100644 --- a/classes/zh_CN/class_editorexportplatformmacos.rst +++ b/classes/zh_CN/class_editorexportplatformmacos.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/macos/doc_classes/EditorExportPlatformMacOS.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/macos/doc_classes/EditorExportPlatformMacOS.xml. .. _class_EditorExportPlatformMacOS: @@ -476,6 +476,8 @@ macOS 导出器。 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/tracking_enabled` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | @@ -643,7 +645,9 @@ App Store 的应用程序分类。 :ref:`String` **application/short_version** :ref:`🔗` -用户可见的应用程序版本，只能包含数字字符（\ ``0-9``\ ）和句点（\ ``.``\ ）。如果留空，则回退到 :ref:`ProjectSettings.application/config/version`\ 。 +Application version visible to the user. Can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Version* value in the generated Xcode project. .. rst-class:: classref-item-separator @@ -667,7 +671,9 @@ App Store 的应用程序分类。 :ref:`String` **application/version** :ref:`🔗` -机器可读的应用程序版本，采用 ``major.minor.patch`` 格式，只能包含数字字符（\ ``0-9``\ ）和句点（\ ``.``\ ）。该值必须在被推送到 App Store 的每个新版本中递增。 +Machine-readable application version in the ``major.minor.patch`` format. Can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented with every new release pushed to the App Store. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Build* value in the generated Xcode project. .. rst-class:: classref-item-separator @@ -3212,6 +3218,18 @@ Apple ID 针对应用的密码。 ---- +.. _class_EditorExportPlatformMacOS_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则着色器将被编译并嵌入到应用程序中。仅当使用 Forward+ 或 Mobile 渲染器时，才支持此选项。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/cleanup_script: .. rst-class:: classref-property @@ -3385,6 +3403,7 @@ Apple ID 针对应用的密码。 构建应用程序可执行文件所使用的 Xcode 版本。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformpc.rst b/classes/zh_CN/class_editorexportplatformpc.rst index 53d733e92c..2927bab3de 100644 --- a/classes/zh_CN/class_editorexportplatformpc.rst +++ b/classes/zh_CN/class_editorexportplatformpc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorExportPlatformPC.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformPC.xml. .. _class_EditorExportPlatformPC: @@ -33,6 +33,7 @@ EditorExportPlatformPC - :doc:`为 Linux 导出 <../tutorials/export/exporting_for_linux>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformvisionos.rst b/classes/zh_CN/class_editorexportplatformvisionos.rst new file mode 100644 index 0000000000..fe8f27a69f --- /dev/null +++ b/classes/zh_CN/class_editorexportplatformvisionos.rst @@ -0,0 +1,2713 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/visionos/doc_classes/EditorExportPlatformVisionOS.xml. + +.. _class_EditorExportPlatformVisionOS: + +EditorExportPlatformVisionOS +============================ + +**继承：** :ref:`EditorExportPlatformAppleEmbedded` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +visionOS 导出器。 + +.. rst-class:: classref-introduction-group + +教程 +---- + +- :doc:`为 iOS 导出 <../tutorials/export/exporting_for_ios>` + +- :doc:`iOS 插件文档索引 <../tutorials/platform/ios/index>` + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/additional_plist_content` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/app_store_team_id` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/bundle_identifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_debug` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_release` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/delete_old_export_files_unconditionally` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_debug` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_release` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/export_project_only` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/min_visionos_version` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_specifier_debug` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_specifier_release` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/short_version` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/signature` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/version` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/arm64` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/access_wifi` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`capabilities/additional` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/performance_a12` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/performance_gaming_tier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`entitlements/additional` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`entitlements/game_center` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`entitlements/increased_memory_limit` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`entitlements/push_notifications` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024_dark` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024_tinted` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/active_keyboard_access_reasons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/camera_usage_description` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/advertising_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/audio_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/browsing_history/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/coarse_location/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/contacts/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/crash_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/credit_info/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/customer_support/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/device_id/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/email_address/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/emails_or_text_messages/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/environment_scanning/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/fitness/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/gameplay_content/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/hands/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/head/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/health/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/name/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_contact_info/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_data_types/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_diagnostic_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_financial_info/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_usage_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_user_content/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/payment_info/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/performance_data/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/phone_number/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/photos_or_videos/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/physical_address/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/precise_location/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/product_interaction/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/purchase_history/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/sensitive_info/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/collected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/user_id/collection_purposes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/linked_to_user` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/used_for_tracking` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/disk_space_access_reasons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/file_timestamp_access_reasons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/microphone_usage_description` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/system_boot_time_access_reasons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`privacy/tracking_domains` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/tracking_enabled` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/user_defaults_access_reasons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_EditorExportPlatformVisionOS_property_application/additional_plist_content: + +.. rst-class:: classref-property + +:ref:`String` **application/additional_plist_content** :ref:`🔗` + +添加到 `Info.plist `__ 文件的根 ```` 部分的其他数据。该值应该是带有键值元素对的 XML 部分，例如： + +.. code:: text + + key_name + value + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/app_store_team_id: + +.. rst-class:: classref-property + +:ref:`String` **application/app_store_team_id** :ref:`🔗` + +Apple 团队 ID，唯一的 10 字符的字符串。要找到你的团队 ID，请检查 Apple 开发者帐户仪表板中的“会员详细信息”部分，或代码签名证书的“组织单位”。见 `查找你的团队 ID `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/bundle_identifier: + +.. rst-class:: classref-property + +:ref:`String` **application/bundle_identifier** :ref:`🔗` + +反向 DNS 格式的唯一应用程序标识符，只能包含字母数字字符（\ ``A-Z``\ 、\ ``a-z`` 和 ``0-9``\ ）、连字符（\ ``-``\ ）和句点（\ ``.``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/code_sign_identity_debug: + +.. rst-class:: classref-property + +:ref:`String` **application/code_sign_identity_debug** :ref:`🔗` + +用于调试导出的签名身份的“全名”、“通用名”或 SHA-1 哈希值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/code_sign_identity_release: + +.. rst-class:: classref-property + +:ref:`String` **application/code_sign_identity_release** :ref:`🔗` + +用于发布导出的签名身份的“全名”、“通用名”或 SHA-1 哈希值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/delete_old_export_files_unconditionally: + +.. rst-class:: classref-property + +:ref:`bool` **application/delete_old_export_files_unconditionally** :ref:`🔗` + +如果为 ``true``\ ，则导出时将无条件删除导出目标目录中已有的“项目名称”和“项目名称.xcodeproj”。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/export_method_debug: + +.. rst-class:: classref-property + +:ref:`int` **application/export_method_debug** :ref:`🔗` + +应用程序分发目标（调试导出）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/export_method_release: + +.. rst-class:: classref-property + +:ref:`int` **application/export_method_release** :ref:`🔗` + +应用程序分发目标（发布导出）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/export_project_only: + +.. rst-class:: classref-property + +:ref:`bool` **application/export_project_only** :ref:`🔗` + +如果为 ``true``\ ，则导出 iOS 项目文件而不构建一份 XCArchive 或 ``.ipa`` 文件。如果为 ``false``\ ，则导出 iOS 项目文件并同时构建一份 XCArchive 和 ``.ipa`` 文件。将 Godot 与 Fastlane 或其他构建管道结合使用时，你可能需要将其设置为 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/icon_interpolation: + +.. rst-class:: classref-property + +:ref:`int` **application/icon_interpolation** :ref:`🔗` + +用于调整应用程序图标大小的插值方法。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/min_visionos_version: + +.. rst-class:: classref-property + +:ref:`String` **application/min_visionos_version** :ref:`🔗` + +.. container:: contribute + + 该属性目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/provisioning_profile_specifier_debug: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_specifier_debug** :ref:`🔗` + +预置描述文件的名称。设置调试时 XCode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 + +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_DEBUG`` 覆盖。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/provisioning_profile_specifier_release: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_specifier_release** :ref:`🔗` + +预置描述文件的名称。设置发布时 XCode 使用的 PROVISIONING_PROFILE_SPECIFIER。\ `用于手动描述 `__\ 。 + +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_RELEASE`` 覆盖。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/provisioning_profile_uuid_debug: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_uuid_debug** :ref:`🔗` + +预置描述文件的 UUID。如果留空，则 Xcode 会自动下载或创建一个预置描述文件。见\ `编辑、下载或删除预置描述文件 `__\ 。 + +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_DEBUG`` 覆盖。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/provisioning_profile_uuid_release: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_uuid_release** :ref:`🔗` + +预置描述文件的 UUID。如果留空，则 Xcode 会自动下载或创建一个预置描述文件。见\ `编辑、下载或删除预置描述文件 `__\ 。 + +可以使用环境变量 ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE`` 覆盖。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/short_version: + +.. rst-class:: classref-property + +:ref:`String` **application/short_version** :ref:`🔗` + +Application version visible to the user. Can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Version* value in the generated Xcode project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/signature: + +.. rst-class:: classref-property + +:ref:`String` **application/signature** :ref:`🔗` + +特定于该捆绑包的四字符创建者码。可选的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_application/version: + +.. rst-class:: classref-property + +:ref:`String` **application/version** :ref:`🔗` + +Machine-readable application version in the ``major.minor.patch`` format. Can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented with every new release pushed to the App Store. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. + +\ **Note:** This value is used for the *Identity > Build* value in the generated Xcode project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_architectures/arm64: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/arm64** :ref:`🔗` + +如果为 ``true``\ ，\ ``arm64`` 二进制文件将包含在导出的项目中。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_capabilities/access_wifi: + +.. rst-class:: classref-property + +:ref:`bool` **capabilities/access_wifi** :ref:`🔗` + +如果为 ``true``\ ，则启用与 Wi-Fi 访问相关的网络功能。见 `App 所需的设备功能 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_capabilities/additional: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **capabilities/additional** :ref:`🔗` + +添加到 ``Info.plist`` 文件的 ``UIRequiredDeviceCapabilities`` 数组中的额外数据。 + +**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_capabilities/performance_a12: + +.. rst-class:: classref-property + +:ref:`bool` **capabilities/performance_a12** :ref:`🔗` + +需要 A12 Bionic 及更高版本芯片（支持所有 Vulkan 渲染器功能的设备）的图形性能和功能。 + +启用该选项会将支持的设备限制为：iPhone XS、iPhone XR、iPad Mini（第 5 代）、iPad Air（第 3 代）、iPad（第 8 代）及更新版本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_capabilities/performance_gaming_tier: + +.. rst-class:: classref-property + +:ref:`bool` **capabilities/performance_gaming_tier** :ref:`🔗` + +需要 A17 Pro 及更高版本芯片的图形性能和功能。 + +启用该选项将支持的设备限制为：iPhone 15 Pro 及更新版本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** :ref:`🔗` + +到自定义导出模板的路径。如果留空，则默认模板将被使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** :ref:`🔗` + +到自定义导出模板的路径。如果留空，则默认模板将被使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_entitlements/additional: + +.. rst-class:: classref-property + +:ref:`String` **entitlements/additional** :ref:`🔗` + +添加到 `.entitlements `__ 文件的根 ```` 部分的其他数据。该值应该是带有键值元素对的 XML 部分，例如： + +.. code:: text + + key_name + value + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_entitlements/game_center: + +.. rst-class:: classref-property + +:ref:`bool` **entitlements/game_center** :ref:`🔗` + +如果为 ``true``\ ，则会允许访问 Game Center 功能。见 `com.apple.developer.game-center `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_entitlements/increased_memory_limit: + +.. rst-class:: classref-property + +:ref:`bool` **entitlements/increased_memory_limit** :ref:`🔗` + +如果为 ``true``\ ，则提示该应用在更高的内存限制下可能表现更好。见 `com.apple.developer.kernel.increased-memory-limit `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_entitlements/push_notifications: + +.. rst-class:: classref-property + +:ref:`String` **entitlements/push_notifications** :ref:`🔗` + +Apple 推送通知服务的环境。见 `aps-environment `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_icons/icon_1024x1024: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024** :ref:`🔗` + +用于生成其他图标的基础应用程序图标。如果留空则会回退到 :ref:`ProjectSettings.application/config/icon`\ 。见 `App 图标 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_icons/icon_1024x1024_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024_dark** :ref:`🔗` + +用于生成其他图标的基础应用程序图标，暗色版本。见 `App 图标 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_icons/icon_1024x1024_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024_tinted** :ref:`🔗` + +用于生成其他图标的基础应用程序图标，着色版本。见 `App 图标 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/active_keyboard_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/active_keyboard_access_reasons** :ref:`🔗` + +你的应用使用活动键盘 API 的原因。请参阅 `描述所需原因 API 的使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/camera_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/camera_usage_description** :ref:`🔗` + +请求访问设备相机时显示的（英文）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/camera_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/camera_usage_description_localized** :ref:`🔗` + +请求访问设备相机时显示的（本地化）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/advertising_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/collected** :ref:`🔗` + +表示你的应用是否会收集广告数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/advertising_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** :ref:`🔗` + +你的应用收集广告数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/advertising_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将广告数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/advertising_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将广告数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/audio_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/collected** :ref:`🔗` + +表示你的应用是否会收集音频数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/audio_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/audio_data/collection_purposes** :ref:`🔗` + +你的应用收集音频数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/audio_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将音频数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/audio_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将音频数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/browsing_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/collected** :ref:`🔗` + +表示你的应用是否会收集浏览历史。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/browsing_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** :ref:`🔗` + +你的应用收集浏览历史记录的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/browsing_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** :ref:`🔗` + +表示你的应用是否会将浏览历史链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/browsing_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将浏览历史用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/coarse_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/collected** :ref:`🔗` + +表示你的应用是否会收集粗略位置数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/coarse_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** :ref:`🔗` + +你的应用收集粗略位置数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/coarse_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** :ref:`🔗` + +表示你的应用是否会将粗略位置数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/coarse_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将粗略位置数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/contacts/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/collected** :ref:`🔗` + +表示你的应用程序是否收集联系人。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/contacts/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/contacts/collection_purposes** :ref:`🔗` + +你的应用收集联系人的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/contacts/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/linked_to_user** :ref:`🔗` + +表示你的应用是否会将通讯录链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/contacts/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将通讯录用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/crash_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/collected** :ref:`🔗` + +表示你的应用是否会收集崩溃数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/crash_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/crash_data/collection_purposes** :ref:`🔗` + +你的应用收集崩溃数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/crash_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将崩溃数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/crash_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将崩溃数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/credit_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/collected** :ref:`🔗` + +表示你的应用程序是否收集信用信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/credit_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/credit_info/collection_purposes** :ref:`🔗` + +你的应用收集信用信息的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/credit_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** :ref:`🔗` + +表示你的应用是否会将信用信息链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/credit_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将信用信息用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/customer_support/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/collected** :ref:`🔗` + +表示你的应用是否会收集客户支持数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/customer_support/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/customer_support/collection_purposes** :ref:`🔗` + +你的应用程序收集客户支持数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/customer_support/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** :ref:`🔗` + +表示你的应用程序是否将客户支持数据链接到用户身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/customer_support/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** :ref:`🔗` + +表示你的应用是否使用客户支持数据进行跟踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/device_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/collected** :ref:`🔗` + +表示你的应用是否会收集设备 ID。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/device_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/device_id/collection_purposes** :ref:`🔗` + +你的应用收集设备 ID 的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/device_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/linked_to_user** :ref:`🔗` + +表示你的应用是否会将设备 ID 链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/device_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将设备 ID 链接用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/email_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/collected** :ref:`🔗` + +表示你的应用是否会收集电子邮件地址。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/email_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/email_address/collection_purposes** :ref:`🔗` + +你的应用程序收集电子邮件地址的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/email_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/linked_to_user** :ref:`🔗` + +表示你的应用是否会将电子邮件地址链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/email_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将电子邮件地址用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/emails_or_text_messages/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** :ref:`🔗` + +表示你的应用是否会收集电子邮件或短信。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/emails_or_text_messages/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** :ref:`🔗` + +你的应用程序收集电子邮件或短信的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/emails_or_text_messages/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** :ref:`🔗` + +表示你的应用是否会将电子邮件或短信链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/emails_or_text_messages/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将电子邮件或短信用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/environment_scanning/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/collected** :ref:`🔗` + +表示你的应用是否会收集环境扫描数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/environment_scanning/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** :ref:`🔗` + +你的应用程序收集环境扫描数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/environment_scanning/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** :ref:`🔗` + +表示你的应用是否会将环境扫描数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/environment_scanning/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将环境扫描数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/fitness/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/collected** :ref:`🔗` + +表示你的应用是否会收集健身和锻炼数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/fitness/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/fitness/collection_purposes** :ref:`🔗` + +你的应用收集健身和锻炼数据的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/fitness/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/linked_to_user** :ref:`🔗` + +表示你的应用是否会将健身和锻炼数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/fitness/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将健身和锻炼数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/gameplay_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/collected** :ref:`🔗` + +表示你的应用是否会收集游戏内容。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/gameplay_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** :ref:`🔗` + +你的应用程序收集游戏内容的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/gameplay_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** :ref:`🔗` + +表示你的应用是否会将游戏内容链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/gameplay_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将游戏内容用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/hands/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/collected** :ref:`🔗` + +表示你的应用是否会收集用户的手部结构和手部移动。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/hands/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/hands/collection_purposes** :ref:`🔗` + +你的应用收集用户的手部结构和手部移动的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/hands/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/linked_to_user** :ref:`🔗` + +表示你的应用是否会将用户的手部结构和手部移动链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/hands/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将用户的手部结构和手部移动用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/head/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/collected** :ref:`🔗` + +表示你的应用是否会收集用户的头部移动。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/head/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/head/collection_purposes** :ref:`🔗` + +你的应用程序收集用户头部运动的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/head/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/linked_to_user** :ref:`🔗` + +表示你的应用是否会将用户的头部移动链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/head/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将用户的头部移动用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/health/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/collected** :ref:`🔗` + +表示你的应用是否会收集健康和医学数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/health/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/health/collection_purposes** :ref:`🔗` + +你的应用收集健康和医学数据的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/health/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/linked_to_user** :ref:`🔗` + +表示你的应用是否会将健康和医学数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/health/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将健康和医学数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/name/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/collected** :ref:`🔗` + +表示你的应用是否会收集用户的姓名。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/name/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/name/collection_purposes** :ref:`🔗` + +你的应用程序收集用户姓名的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/name/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/linked_to_user** :ref:`🔗` + +表示你的应用是否会将用户的姓名链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/name/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将用户的姓名用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_contact_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/collected** :ref:`🔗` + +表示你的应用程序是否收集任何其他联系信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_contact_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** :ref:`🔗` + +你的应用收程序集任何其他联系信息的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_contact_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其他联系信息链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_contact_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其他联系信息用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_data_types/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/collected** :ref:`🔗` + +表示你的应用是否会收集任何其它数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_data_types/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** :ref:`🔗` + +你的应用程序收集任何其他数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_data_types/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其它数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_data_types/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其它数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_diagnostic_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** :ref:`🔗` + +表示你的应用是否会收集任何其它诊断数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_diagnostic_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** :ref:`🔗` + +你的应用程序收集任何其他诊断数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_diagnostic_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其它诊断数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_diagnostic_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其它诊断数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_financial_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/collected** :ref:`🔗` + +表示你的应用程序是否收集任何其他财务信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_financial_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** :ref:`🔗` + +你的应用程序收集任何其他财务信息的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_financial_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其它财务信息链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_financial_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其它财务信息用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_usage_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/collected** :ref:`🔗` + +表示你的应用是否会收集任何其它使用数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_usage_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** :ref:`🔗` + +你的应用程序收集任何其他使用数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_usage_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其它使用数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_usage_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其它使用数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_user_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/collected** :ref:`🔗` + +表示你的应用是否会收集任何其它用户生成内容。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_user_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** :ref:`🔗` + +你的应用程序收集任何其他用户生成内容的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_user_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** :ref:`🔗` + +表示你的应用是否会将任何其它用户生成内容链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/other_user_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将任何其它用户生成内容用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/payment_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/collected** :ref:`🔗` + +表示你的应用程序是否收集支付信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/payment_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/payment_info/collection_purposes** :ref:`🔗` + +你的应用程序收集支付信息的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/payment_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** :ref:`🔗` + +表示你的应用是否会将支付信息链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/payment_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将支付信息用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/performance_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/collected** :ref:`🔗` + +表示你的应用程序是否收集性能数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/performance_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/performance_data/collection_purposes** :ref:`🔗` + +你的应用收集性能数据的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/performance_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** :ref:`🔗` + +表示你的应用是否会将性能数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/performance_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将性能数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/phone_number/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/collected** :ref:`🔗` + +表示你的应用是否会收集电话号码。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/phone_number/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/phone_number/collection_purposes** :ref:`🔗` + +你的应用程序收集电话号码的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/phone_number/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** :ref:`🔗` + +表示你的应用是否会将电话号码链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/phone_number/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将电话号码用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/photos_or_videos/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/collected** :ref:`🔗` + +表示你的应用程序是否收集照片或视频。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/photos_or_videos/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** :ref:`🔗` + +你的应用程序收集照片或视频的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/photos_or_videos/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** :ref:`🔗` + +表示你的应用是否会将照片或视频链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/photos_or_videos/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将照片或视频用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/physical_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/collected** :ref:`🔗` + +表示你的应用是否会收集实际住址。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/physical_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/physical_address/collection_purposes** :ref:`🔗` + +你的应用收集实际住址的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/physical_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** :ref:`🔗` + +表示你的应用是否会将实际住址链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/physical_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将实际住址用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/precise_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/collected** :ref:`🔗` + +表示你的应用是否会收集精确位置数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/precise_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/precise_location/collection_purposes** :ref:`🔗` + +你的应用程序收集精确位置数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/precise_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** :ref:`🔗` + +表示你的应用是否会将精确位置数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/precise_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将精确位置数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/product_interaction/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/collected** :ref:`🔗` + +表示你的应用是否会收集产品互动数据。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/product_interaction/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** :ref:`🔗` + +你的应用程序收集产品互动数据的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/product_interaction/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** :ref:`🔗` + +表示你的应用是否会将产品互动数据链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/product_interaction/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将产品互动数据用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/purchase_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/collected** :ref:`🔗` + +表示你的应用是否会收集购买历史。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/purchase_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** :ref:`🔗` + +你的应用收集购买历史的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/purchase_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** :ref:`🔗` + +表示你的应用是否会将购买历史链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/purchase_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将购买历史用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` + +表示你的应用程序是否收集搜索历史记录。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` + +你的应用程序收集搜索历史的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` + +表示你的应用是否会将搜索历史链接到用户的身份。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` + +表示你的应用是否会将搜索历史用于追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/sensitive_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/collected** :ref:`🔗` + +表示你的应用程序是否收集敏感的用户信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/sensitive_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** :ref:`🔗` + +你的应用程序收集敏感用户信息的原因。请参阅 `描述隐私清单中的数据使用 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/sensitive_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** :ref:`🔗` + +表示你的 app 是否会将敏感用户信息链接到用户的身份上。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/sensitive_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** :ref:`🔗` + +表示你的 app 是否会将敏感用户信息用于跟踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/user_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/collected** :ref:`🔗` + +表示你的 app 是否会收集用户 ID。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/user_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/user_id/collection_purposes** :ref:`🔗` + +你的 app 收集用户 ID 的原因。见\ `《在隐私清单中描述数据用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/user_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/linked_to_user** :ref:`🔗` + +表示你的 app 是否会将用户 ID 链接到用户的身份上。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/user_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** :ref:`🔗` + +表示你的 app 是否会将用户 ID 用于跟踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/disk_space_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/disk_space_access_reasons** :ref:`🔗` + +你的 app 使用磁盘空间清理 API 的原因。见\ `《描述使用需要原因的 API 的用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/file_timestamp_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/file_timestamp_access_reasons** :ref:`🔗` + +你的 app 使用文件时间戳/元数据 API 的原因。见\ `《描述使用需要原因的 API 的用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/microphone_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/microphone_usage_description** :ref:`🔗` + +请求访问设备麦克风时显示的（英文）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/microphone_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/microphone_usage_description_localized** :ref:`🔗` + +请求访问设备麦克风时显示的（本地化）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/photolibrary_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/photolibrary_usage_description** :ref:`🔗` + +请求访问用户照片图库时显示的（英文）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/photolibrary_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/photolibrary_usage_description_localized** :ref:`🔗` + +请求访问用户照片图库时显示的（本地化）消息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/system_boot_time_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/system_boot_time_access_reasons** :ref:`🔗` + +你的 app 使用系统启动时间/绝对时间 API 的原因。见\ `《描述使用需要原因的 API 的用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/tracking_domains: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **privacy/tracking_domains** :ref:`🔗` + +你的应用程序连接到的参与跟踪的互联网域列表。请参阅 `隐私清单文件 `__\ 。 + +**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/tracking_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/tracking_enabled** :ref:`🔗` + +表示你的应用程序是否使用数据进行跟踪。请参阅 `隐私清单文件 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_privacy/user_defaults_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/user_defaults_access_reasons** :ref:`🔗` + +你的 app 使用用户默认值 API 的原因。见\ `《描述使用需要原因的 API 的用途》 `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则会将着色器进行编译并嵌入至应用程序中。该选项仅在使用 Forward+ 和 Mobile 渲染器时支持。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_user_data/accessible_from_files_app: + +.. rst-class:: classref-property + +:ref:`bool` **user_data/accessible_from_files_app** :ref:`🔗` + +如果为 ``true``\ ，应用的“Documents”文件夹可以在“文件”应用中访问。见 `LSSupportsOpeningDocumentsInPlace `__\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformVisionOS_property_user_data/accessible_from_itunes_sharing: + +.. rst-class:: classref-property + +:ref:`bool` **user_data/accessible_from_itunes_sharing** :ref:`🔗` + +如果为 ``true``\ ，应用的“Documents”文件夹可以在 iTunes 文件共享中访问。见 `UIFileSharingEnabled `__\ 。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_editorexportplatformweb.rst b/classes/zh_CN/class_editorexportplatformweb.rst index 82fe2c1dbb..7e6f9b4cb1 100644 --- a/classes/zh_CN/class_editorexportplatformweb.rst +++ b/classes/zh_CN/class_editorexportplatformweb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/web/doc_classes/EditorExportPlatformWeb.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/web/doc_classes/EditorExportPlatformWeb.xml. .. _class_EditorExportPlatformWeb: @@ -75,6 +75,10 @@ Web 导出器能够自定义 web 构建的处理方式。在编辑器的“导 +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`progressive_web_app/orientation` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`threads/emscripten_pool_size` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`threads/godot_pool_size` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`variant/extensions_support` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`variant/thread_support` | @@ -331,6 +335,34 @@ Web 应用程序后面使用的背景颜色。 ---- +.. _class_EditorExportPlatformWeb_property_threads/emscripten_pool_size: + +.. rst-class:: classref-property + +:ref:`int` **threads/emscripten_pool_size** :ref:`🔗` + +Emscripten 在启动时分配的线程数。较小的值将分配较少的线程，消耗较少的系统资源，但可能会面临池中线程用完的风险，需要在运行时分配更多线程，可能导致死锁。 + +\ **注意：**\ 一些浏览器对可分配的线程数量有严格的限制，因此最好谨慎行事，保持较低的线程数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_threads/godot_pool_size: + +.. rst-class:: classref-property + +:ref:`int` **threads/godot_pool_size** :ref:`🔗` + +:ref:`WorkerThreadPool` 默认大小的覆盖值。当 :ref:`ProjectSettings.threading/worker_pool/max_threads` 设置为 -1（默认）时会使用该设置。该大小必须小于 :ref:`threads/emscripten_pool_size`\ ，否则可能造成死锁。 + +使用线程时，该大小需要足够大，以容纳依赖于拥有专用线程的特性，例如 :ref:`ProjectSettings.physics/2d/run_on_separate_thread` 和 :ref:`ProjectSettings.rendering/driver/threads/thread_model`\ 。一般来说，最好确保这个值至少为 4，并且至少比 :ref:`threads/emscripten_pool_size` 小 2 或 3。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformWeb_property_variant/extensions_support: .. rst-class:: classref-property @@ -378,6 +410,7 @@ Web 应用程序后面使用的背景颜色。 如果为 ``true``\ ，则允许通过 ETC2/ASTC 算法针对移动设备优化纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplatformwindows.rst b/classes/zh_CN/class_editorexportplatformwindows.rst index 202f7021d8..34ee7f0fc2 100644 --- a/classes/zh_CN/class_editorexportplatformwindows.rst +++ b/classes/zh_CN/class_editorexportplatformwindows.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/platform/windows/doc_classes/EditorExportPlatformWindows.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/windows/doc_classes/EditorExportPlatformWindows.xml. .. _class_EditorExportPlatformWindows: @@ -93,6 +93,8 @@ Windows 导出器可以自定义 Windows 构建的处理方法。在编辑器的 +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/export_console_wrapper` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shader_baker/enabled` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | @@ -467,6 +469,18 @@ Windows 导出器可以自定义 Windows 构建的处理方法。在编辑器的 ---- +.. _class_EditorExportPlatformWindows_property_shader_baker/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **shader_baker/enabled** :ref:`🔗` + +如果为 ``true``\ ，则会将着色器进行编译并嵌入至应用程序中。该选项仅在使用 Forward+ 和 Mobile 渲染器时支持。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script: .. rst-class:: classref-property @@ -592,6 +606,7 @@ Windows 导出器可以自定义 Windows 构建的处理方法。在编辑器的 如果为 ``true``\ ，则项目中的纹理在导出时使用 S3TC/BPTC 格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportplugin.rst b/classes/zh_CN/class_editorexportplugin.rst index 6a28b902db..509fb5a8ac 100644 --- a/classes/zh_CN/class_editorexportplugin.rst +++ b/classes/zh_CN/class_editorexportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorExportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlugin.xml. .. _class_EditorExportPlugin: @@ -43,9 +43,9 @@ EditorExportPlugin +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_begin_customize_scenes`\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`_customize_resource`\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| | + | :ref:`Resource` | :ref:`_customize_resource`\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |required| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`_customize_scene`\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| | + | :ref:`Node` | :ref:`_customize_scene`\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| |required| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_end_customize_resources`\ (\ ) |virtual| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,7 +69,7 @@ EditorExportPlugin +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_android_manifest_element_contents`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_customization_configuration_hash`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_customization_configuration_hash`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_export_features`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,12 +81,28 @@ EditorExportPlugin +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_get_export_options_overrides`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_should_update_export_options`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_supports_platform`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_update_android_prebuilt_manifest`\ (\ platform\: :ref:`EditorExportPlatform`, manifest_data\: :ref:`PackedByteArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_bundle_file`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_cpp_code`\ (\ code\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_embedded_framework`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_framework`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_linker_flags`\ (\ flags\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_plist_content`\ (\ plist_content\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_apple_embedded_platform_project_static_lib`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_file`\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_ios_bundle_file`\ (\ path\: :ref:`String`\ ) | @@ -159,7 +175,7 @@ EditorExportPlugin .. rst-class:: classref-method -:ref:`Resource` **_customize_resource**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`Resource` **_customize_resource**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 对资源进行自定义。如果进行了修改，请返回相同的或新的资源，否则请返回 ``null`` 。如果返回的是新资源，则会使用新资源的副本替换 ``resource``\ 。 @@ -189,7 +205,7 @@ EditorExportPlugin .. rst-class:: classref-method -:ref:`Node` **_customize_scene**\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`Node` **_customize_scene**\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 定制一个场景。如果对其进行了修改，则返回相同的或新的场景。否则，返回 ``null`` 。如果返回一个新的场景，则由你来处理旧的场景。 @@ -357,7 +373,7 @@ EditorExportPlugin .. rst-class:: classref-method -:ref:`int` **_get_customization_configuration_hash**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_customization_configuration_hash**\ (\ ) |virtual| |required| |const| :ref:`🔗` 根据传入的配置返回一个哈希值（对于场景和资源）。这有助于为单独的导出配置保留单独的缓存。 @@ -385,8 +401,6 @@ EditorExportPlugin :ref:`bool` **_get_export_option_visibility**\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 验证 ``option`` 并返回 ``platform`` 平台是否可见。默认实现会为所有选项都返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -440,13 +454,13 @@ EditorExportPlugin class MyExportPlugin extends EditorExportPlugin: func _get_name() -> String: return "MyExportPlugin" - + func _supports_platform(platform) -> bool: if platform is EditorExportPlatformPC: # 可在所有桌面平台上运行，包括 Windows、MacOS 和 Linux。 return true return false - + func _get_export_options_overrides(platform) -> Dictionary: # 覆盖“嵌入 PCK”以始终启用。 return { @@ -461,7 +475,7 @@ EditorExportPlugin .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回该插件的名称标识符（供导出器将来识别）。插件在导出前按名称排序。 @@ -477,7 +491,7 @@ EditorExportPlugin :ref:`bool` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| :ref:`🔗` -如果 :ref:`_get_export_options()` 的结果发生了改变，与 ``platform`` 对应的导出预设的选项需要更新，则返回 ``true``\ 。 +如果 :ref:`_get_export_options()` 的结果发生了改变，且与 ``platform`` 对应的导出预设的选项需要更新，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -495,6 +509,110 @@ EditorExportPlugin ---- +.. _class_EditorExportPlugin_private_method__update_android_prebuilt_manifest: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **_update_android_prebuilt_manifest**\ (\ platform\: :ref:`EditorExportPlatform`, manifest_data\: :ref:`PackedByteArray`\ ) |virtual| |const| :ref:`🔗` + +提供对 Android 预构建清单文件的访问，允许插件在需要时对其进行修改。 + +该虚方法的实现者应该从 ``manifest_data`` 中获取二进制清单数据，对其进行复制、修改等操作，然后返回修改后的内容。 + +如果不需要修改，则应返回一个空的 :ref:`PackedByteArray`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_bundle_file: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_bundle_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +将路径为 ``path`` 的 Apple 嵌入式平台捆绑包文件添加到导出的项目中。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_cpp_code: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_cpp_code**\ (\ code\: :ref:`String`\ ) :ref:`🔗` + +将 C++ 代码添加到 Apple 嵌入式平台导出中。最终代码是根据各个活动导出插件附加的代码创建的。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_embedded_framework: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_embedded_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +将动态库（\*.dylib、\*.framework）添加到 Apple 嵌入式平台的 Xcode 项目的链接阶段，并将其嵌入到生成的二进制文件中。 + +\ **注意：**\ 对于静态库（\*.a），该方法的工作方式与 :ref:`add_apple_embedded_platform_framework()` 相同。 + +\ **注意：**\ 此方法不该用于系统库，因为它们已经存在于设备上。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_framework: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +在 Apple 嵌入式平台的 Xcode 项目中链接阶段添加静态库（\*.a）或动态库（\*.dylib、\*.framework）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_linker_flags: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_linker_flags**\ (\ flags\: :ref:`String`\ ) :ref:`🔗` + +为 Apple 嵌入式平台导出添加链接器标志。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_plist_content: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_plist_content**\ (\ plist_content\: :ref:`String`\ ) :ref:`🔗` + +向 Apple 嵌入式平台项目的 Info.plist 文件中添加额外的字段。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlugin_method_add_apple_embedded_platform_project_static_lib: + +.. rst-class:: classref-method + +|void| **add_apple_embedded_platform_project_static_lib**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +向 Apple 嵌入式平台项目中添加路径为 ``path`` 的静态库。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method_add_file: .. rst-class:: classref-method @@ -517,6 +635,8 @@ EditorExportPlugin |void| **add_ios_bundle_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` +**已弃用：** Use :ref:`add_apple_embedded_platform_bundle_file()` instead. + 将给定的\ ``path``\ 中的iOS bundle文件添加到导出的项目中。 .. rst-class:: classref-item-separator @@ -529,7 +649,9 @@ EditorExportPlugin |void| **add_ios_cpp_code**\ (\ code\: :ref:`String`\ ) :ref:`🔗` -将 C++ 代码添加到 iOS 导出中。最终的代码是由每个激活的导出插件附加的代码创建的。 +**已弃用：** Use :ref:`add_apple_embedded_platform_cpp_code()` instead. + +将 C++ 代码添加到 iOS 导出中。最终的代码是根据各个激活的导出插件附加的代码创建的。 .. rst-class:: classref-item-separator @@ -541,11 +663,13 @@ EditorExportPlugin |void| **add_ios_embedded_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` +**已弃用：** Use :ref:`add_apple_embedded_platform_embedded_framework()` instead. + 将动态库（\*.dylib、\*.framework）添加到 iOS 的 Xcode 项目的链接阶段，并将其嵌入到生成的二进制文件中。 -\ **注意：**\ 对于静态库（\*.a），该方法的工作方式与 :ref:`add_ios_framework()` 相同。 +\ **注意：**\ 对于静态库（\*.a），该方法的工作方式与 :ref:`add_apple_embedded_platform_framework()` 相同。 -\ **注意：**\ 此方法不该用于系统库，因为它们已经存在于设备上。 +\ **注意：**\ 该方法不该用于系统库，因为它们已经存在于设备上。 .. rst-class:: classref-item-separator @@ -557,6 +681,8 @@ EditorExportPlugin |void| **add_ios_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` +**已弃用：** Use :ref:`add_apple_embedded_platform_framework()` instead. + 在 iOS 的 Xcode 项目中链接阶段添加静态库（\*.a）或动态库（\*.dylib、\*.framework）。 .. rst-class:: classref-item-separator @@ -569,6 +695,8 @@ EditorExportPlugin |void| **add_ios_linker_flags**\ (\ flags\: :ref:`String`\ ) :ref:`🔗` +**已弃用：** Use :ref:`add_apple_embedded_platform_linker_flags()` instead. + 为 iOS 导出添加链接器标志。 .. rst-class:: classref-item-separator @@ -581,7 +709,9 @@ EditorExportPlugin |void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String`\ ) :ref:`🔗` -为 iOS 属性列表文件添加内容。 +**已弃用：** Use :ref:`add_apple_embedded_platform_plist_content()` instead. + +向 iOS 项目的 Info.plist 文件中添加额外字段。 .. rst-class:: classref-item-separator @@ -593,7 +723,9 @@ EditorExportPlugin |void| **add_ios_project_static_lib**\ (\ path\: :ref:`String`\ ) :ref:`🔗` -向 iOS 项目中添加位于给定路径 ``path`` 的静态库。 +**已弃用：** Use :ref:`add_apple_embedded_platform_project_static_lib()` instead. + +向 iOS 项目中添加路径为 ``path`` 的静态库。 .. rst-class:: classref-item-separator @@ -674,6 +806,7 @@ EditorExportPlugin 在 :ref:`_export_file()` 中调用。跳过当前文件，因此它不包含在导出中。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorexportpreset.rst b/classes/zh_CN/class_editorexportpreset.rst index 3fe9a45052..95442d27d4 100644 --- a/classes/zh_CN/class_editorexportpreset.rst +++ b/classes/zh_CN/class_editorexportpreset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorExportPreset.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPreset.xml. .. _class_EditorExportPreset: @@ -19,7 +19,7 @@ EditorExportPreset 描述 ---- -导出预设配置。编辑器 UI 中的 **EditorExportPreset** 实例，旨在用作导出项目时传入 :ref:`EditorExportPlatform` 方法的只读配置。 +表示由编辑器的导出对话框创建的导出预设的配置。\ **EditorExportPreset** 实例旨在用作在导出项目时传递给 :ref:`EditorExportPlatform` 方法的只读配置。 .. rst-class:: classref-reftable-group @@ -66,6 +66,8 @@ EditorExportPreset +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_preset_name`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_project_setting`\ (\ name\: :ref:`StringName`\ ) | + +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_script_export_mode`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_version`\ (\ name\: :ref:`StringName`, windows_version\: :ref:`bool`\ ) |const| | @@ -285,7 +287,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`String` **get_custom_features**\ (\ ) |const| :ref:`🔗` -返回用英文逗号分隔的自定义特性列表字符串。 +返回添加至该预设的自定义特性列表，是一个用英文逗号分隔的字符串。详见《\ :doc:`特性标签 <../tutorials/export/feature_tags>`\ 》文档。 .. rst-class:: classref-item-separator @@ -297,7 +299,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`Dictionary` **get_customized_files**\ (\ ) |const| :ref:`🔗` -返回一个 :ref:`Dictionary`\ ，包含在导出对话框的“资源”选项卡中选择的文件。字典的键是文件名，值是导出模式 ：\ ``"strip"``\ 、\ ``"keep"`` 或 ``"remove"``\ 。另见 :ref:`get_file_export_mode()`\ 。 +返回在导出对话框“资源”选项卡中选中的所有文件，是一个字典。字典的键是文件名，值是对应的导出模式 ：\ ``"strip"``\ 、\ ``"keep"`` 或 ``"remove"``\ 。另见 :ref:`get_file_export_mode()`\ 。 .. rst-class:: classref-item-separator @@ -309,7 +311,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`int` **get_customized_files_count**\ (\ ) |const| :ref:`🔗` -返回导出对话框的“资源”选项卡中选中文件的数量。 +返回在导出对话框“资源”选项卡中选中的文件数。 .. rst-class:: classref-item-separator @@ -321,7 +323,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`bool` **get_encrypt_directory**\ (\ ) |const| :ref:`🔗` -返回 ``true`` 表示在导出对话框中启用了 PCK 目录加密。 +如果导出对话框中启用了 PCK 目录加密，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -333,7 +335,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`bool` **get_encrypt_pck**\ (\ ) |const| :ref:`🔗` -返回 ``true`` 表示在导出对话框中启用了 PCK 加密。 +如果导出对话框中启用了 PCK 加密，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -483,13 +485,25 @@ enum **ScriptExportMode**: :ref:`🔗` ---- +.. _class_EditorExportPreset_method_get_project_setting: + +.. rst-class:: classref-method + +:ref:`Variant` **get_project_setting**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` + +返回名为 ``name`` 的设置项的值，会使用导出预设特性标签覆盖，不使用当前操作系统的特性。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPreset_method_get_script_export_mode: .. rst-class:: classref-method :ref:`int` **get_script_export_mode**\ (\ ) |const| :ref:`🔗` -返回脚本导出模式。 +返回 GDScript 文件的导出模式。\ ``0`` 表示“文本”，\ ``1`` 表示“二进制标记”，\ ``2`` 表示“压缩二进制标记（文件较小）”。 .. rst-class:: classref-item-separator @@ -515,7 +529,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`bool` **has**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` -如果预设中存在指定的属性，则返回 ``true``\ 。 +如果预设中存在名为 ``property`` 的属性，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -527,7 +541,7 @@ enum **ScriptExportMode**: :ref:`🔗` :ref:`bool` **has_export_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` -如果导出了指定的文件，则返回 ``true``\ 。 +如果会导出路径为 ``path`` 的文件，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -554,6 +568,7 @@ enum **ScriptExportMode**: :ref:`🔗` 如果为导出对话框中打开了“可执行”开关，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorfeatureprofile.rst b/classes/zh_CN/class_editorfeatureprofile.rst index 2c5633fe3a..d29f09c93c 100644 --- a/classes/zh_CN/class_editorfeatureprofile.rst +++ b/classes/zh_CN/class_editorfeatureprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorFeatureProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFeatureProfile.xml. .. _class_EditorFeatureProfile: @@ -292,6 +292,7 @@ AssetLib 选项卡。如果禁用此功能，则不会显示 AssetLib 选项卡 如果 ``disable`` 为 ``true``\ ，则禁用 ``feature`` 中指定的编辑器功能。当一个功能被禁用时，它将从编辑器中完全消失。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorfiledialog.rst b/classes/zh_CN/class_editorfiledialog.rst index 70eb718381..0ea951d909 100644 --- a/classes/zh_CN/class_editorfiledialog.rst +++ b/classes/zh_CN/class_editorfiledialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorFileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileDialog.xml. .. _class_EditorFileDialog: @@ -393,7 +393,7 @@ enum **DisplayMode**: :ref:`🔗` - |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) - :ref:`FileMode` **get_file_mode**\ (\ ) -对话框的打开或保存模式，会影响选择行为。见 :ref:`FileMode`\ 。 +对话框的打开或保存模式，会影响选择行为。 .. rst-class:: classref-item-separator @@ -680,6 +680,7 @@ enum **DisplayMode**: :ref:`🔗` 设置索引为 ``option`` 的 :ref:`OptionButton` 的选项值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorfilesystem.rst b/classes/zh_CN/class_editorfilesystem.rst index cf1c005cdb..31cbb27488 100644 --- a/classes/zh_CN/class_editorfilesystem.rst +++ b/classes/zh_CN/class_editorfilesystem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorFileSystem.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystem.xml. .. _class_EditorFileSystem: @@ -248,6 +248,7 @@ EditorFileSystem 这不会导入文件。要重新导入，请调用 :ref:`reimport_files()` 或 :ref:`scan()` 方法。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorfilesystemdirectory.rst b/classes/zh_CN/class_editorfilesystemdirectory.rst index 851c549ba7..56f422f2d6 100644 --- a/classes/zh_CN/class_editorfilesystemdirectory.rst +++ b/classes/zh_CN/class_editorfilesystemdirectory.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorFileSystemDirectory.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystemDirectory.xml. .. _class_EditorFileSystemDirectory: @@ -233,6 +233,7 @@ EditorFileSystemDirectory 返回这个目录的子目录的数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorfilesystemimportformatsupportquery.rst b/classes/zh_CN/class_editorfilesystemimportformatsupportquery.rst index de5ef75045..832e493421 100644 --- a/classes/zh_CN/class_editorfilesystemimportformatsupportquery.rst +++ b/classes/zh_CN/class_editorfilesystemimportformatsupportquery.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorFileSystemImportFormatSupportQuery.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystemImportFormatSupportQuery.xml. .. _class_EditorFileSystemImportFormatSupportQuery: @@ -29,13 +29,13 @@ EditorFileSystemImportFormatSupportQuery .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_file_extensions`\ (\ ) |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_active`\ (\ ) |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_query`\ (\ ) |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_file_extensions`\ (\ ) |virtual| |required| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_active`\ (\ ) |virtual| |required| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_query`\ (\ ) |virtual| |required| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ EditorFileSystemImportFormatSupportQuery .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_file_extensions**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedStringArray` **_get_file_extensions**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回支持的文件扩展名。 @@ -62,7 +62,7 @@ EditorFileSystemImportFormatSupportQuery .. rst-class:: classref-method -:ref:`bool` **_is_active**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_active**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回此导入器是否处于活动状态。 @@ -74,11 +74,12 @@ EditorFileSystemImportFormatSupportQuery .. rst-class:: classref-method -:ref:`bool` **_query**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_query**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询支持。如果不能继续导入，则返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorimportplugin.rst b/classes/zh_CN/class_editorimportplugin.rst index 677d7bde61..edd3212113 100644 --- a/classes/zh_CN/class_editorimportplugin.rst +++ b/classes/zh_CN/class_editorimportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorImportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorImportPlugin.xml. .. _class_EditorImportPlugin: @@ -32,82 +32,82 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 @tool extends EditorImportPlugin - + func _get_importer_name(): return "my.special.plugin" - + func _get_visible_name(): return "Special Mesh" - + func _get_recognized_extensions(): return ["special", "spec"] - + func _get_save_extension(): return "mesh" - + func _get_resource_type(): return "Mesh" - + func _get_preset_count(): return 1 - + func _get_preset_name(preset_index): return "Default" - + func _get_import_options(path, preset_index): return [{"name": "my_option", "default_value": false}] - + func _import(source_file, save_path, options, platform_variants, gen_files): var file = FileAccess.open(source_file, FileAccess.READ) if file == null: return FAILED var mesh = ArrayMesh.new() # 使用从“file”中读取的数据填充 Mesh，留作读者的练习。 - + var filename = save_path + "." + _get_save_extension() return ResourceSaver.save(mesh, filename) .. code-tab:: csharp using Godot; - + public partial class MySpecialPlugin : EditorImportPlugin { public override string _GetImporterName() { return "my.special.plugin"; } - + public override string _GetVisibleName() { return "Special Mesh"; } - + public override string[] _GetRecognizedExtensions() { return ["special", "spec"]; } - + public override string _GetSaveExtension() { return "mesh"; } - + public override string _GetResourceType() { return "Mesh"; } - + public override int _GetPresetCount() { return 1; } - + public override string _GetPresetName(int presetIndex) { return "Default"; } - + public override Godot.Collections.Array _GetImportOptions(string path, int presetIndex) { return @@ -119,7 +119,7 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 }, ]; } - + public override Error _Import(string sourceFile, string savePath, Godot.Collections.Dictionary options, Godot.Collections.Array platformVariants, Godot.Collections.Array genFiles) { using var file = FileAccess.Open(sourceFile, FileAccess.ModeFlags.Read); @@ -127,7 +127,7 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 { return Error.Failed; } - + var mesh = new ArrayMesh(); // 使用从“file”中读取的数据填充 Mesh，留作读者的练习 string filename = $"{savePath}.{_GetSaveExtension()}"; @@ -265,37 +265,35 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 :ref:`bool` **_get_option_visibility**\ (\ path\: :ref:`String`, option_name\: :ref:`StringName`, options\: :ref:`Dictionary`\ ) |virtual| |const| :ref:`🔗` -覆盖此方法就可以在满足条件时隐藏指定的导入选项。主要用于当某些选项存在依赖项时，如果禁用了某个依赖项就隐藏这些选项。 +获取名为 ``option_name`` 的导入选项是否应当在“导入”面板中可见。默认实现始终返回 ``true``\ ，即所有选项均可见。主要用于在禁用某个选项时隐藏与其存在依赖关系的选项。 .. tabs:: .. code-tab:: gdscript - func _get_option_visibility(option, options): - # 仅在压缩模式设为“Lossy”时显示有损压缩质量设置。 - if option == "compress/lossy_quality" and options.has("compress/mode"): + func _get_option_visibility(path, option_name, options): + # 只有在压缩模式为“Lossy”时显示 Lossy 质量设置。 + if option_name == "compress/lossy_quality" and options.has("compress/mode"): return int(options["compress/mode"]) == COMPRESS_LOSSY # 这是你设置的常量 - + return true .. code-tab:: csharp - public void _GetOptionVisibility(string option, Godot.Collections.Dictionary options) + public override bool _GetOptionVisibility(string path, StringName optionName, Godot.Collections.Dictionary options) { - // 仅在压缩模式设为“Lossy”时显示有损压缩质量设置。 - if (option == "compress/lossy_quality" && options.ContainsKey("compress/mode")) + // 只有在压缩模式为“Lossy”时显示 Lossy 质量设置。 + if (optionName == "compress/lossy_quality" && options.ContainsKey("compress/mode")) { return (int)options["compress/mode"] == CompressLossy; // 这是你设置的常量 } - + return true; } -返回 ``true`` 会让所有选项始终可见。 - .. rst-class:: classref-item-separator ---- @@ -390,9 +388,13 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 :ref:`Error` **_import**\ (\ source_file\: :ref:`String`, save_path\: :ref:`String`, options\: :ref:`Dictionary`, platform_variants\: :ref:`Array`\[:ref:`String`\], gen_files\: :ref:`Array`\[:ref:`String`\]\ ) |virtual| |const| :ref:`🔗` -使用指定的导入选项 ``options`` 将 ``source_file`` 导入到 ``save_path`` 中。此函数将修改 ``platform_variants`` 和 ``gen_files`` 数组。 +使用导入选项 ``options`` 导入源文件 ``source_file``\ 。如果导入成功应返回 :ref:`@GlobalScope.OK`\ ，其他值表示失败。 -必须重写这个方法才能完成实际的导入工作。参阅本类的描述以了解如何重写该方法。 +导入的资源应保存至 ``save_path + "." + _get_save_extension()``\ 。如果希望针对某个\ :doc:`特性标签 <../tutorials/export/feature_tags>`\ 优先使用不同的版本，请将该版本的资源保存至 ``save_path + "." + 标签 + "." + _get_save_extension()``\ ，并将该特性标签添加至 ``platform_variants``\ 。 + +如果在资源文件系统（\ ``res://``\ ）中生成了额外的资源文件，请将其完整路径添加至 ``gen_files``\ ，从而使编辑器得知这些文件依赖于 ``source_file``\ 。 + +必须覆盖这个方法进行实际的导入工作。覆盖示例见这个类的描述。 .. rst-class:: classref-item-separator @@ -407,6 +409,7 @@ EditorImportPlugin 通过与特定的文件扩展名和资源类型相关联来 该函数只能在 :ref:`_import()` 回调期间调用，它允许从中手动导入资源。当导入的文件生成需要导入的外部资源（例如图像）时，这很有用。“.import”文件的自定义参数可以通过 ``custom_options`` 传递。此外，在多个导入器可以处理一个文件的情况下，可以指定 ``custom_importer`` 以强制使用某个特定的导入器。该函数会执行一次资源导入并立即返回成功或错误代码。\ ``generator_parameters`` 定义可选的额外元数据，这些元数据将作为 ``generator_parameters`` 存储在 ``.import`` 文件的 ``remap`` 小节中，例如存储源数据的一个 md5 散列值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorinspector.rst b/classes/zh_CN/class_editorinspector.rst index e976af7fc4..7e9b226a8f 100644 --- a/classes/zh_CN/class_editorinspector.rst +++ b/classes/zh_CN/class_editorinspector.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorInspector.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInspector.xml. .. _class_EditorInspector: @@ -238,6 +238,7 @@ EditorInspector 创建一个属性编辑器，可以用在插件 UI 中，编辑 ``object`` 中指定属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorinspectorplugin.rst b/classes/zh_CN/class_editorinspectorplugin.rst index 3d05ea6a49..3e052d38b5 100644 --- a/classes/zh_CN/class_editorinspectorplugin.rst +++ b/classes/zh_CN/class_editorinspectorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorInspectorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInspectorPlugin.xml. .. _class_EditorInspectorPlugin: @@ -186,6 +186,7 @@ EditorInspectorPlugin 添加能够修改多个属性的编辑器。\ ``editor`` 控件必须扩展 :ref:`EditorProperty`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorinterface.rst b/classes/zh_CN/class_editorinterface.rst index 8fa2fddadc..4088429401 100644 --- a/classes/zh_CN/class_editorinterface.rst +++ b/classes/zh_CN/class_editorinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInterface.xml. .. _class_EditorInterface: @@ -59,6 +59,8 @@ Godot 编辑器的接口。 .. table:: :widths: auto + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`close_scene`\ (\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`edit_node`\ (\ node\: :ref:`Node`\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -100,6 +102,8 @@ Godot 编辑器的接口。 +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInspector` | :ref:`get_inspector`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_open_scene_roots`\ (\ ) |const| | + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_open_scenes`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_playing_scene`\ (\ ) |const| | @@ -221,6 +225,18 @@ Godot 编辑器的接口。 方法说明 -------- +.. _class_EditorInterface_method_close_scene: + +.. rst-class:: classref-method + +:ref:`Error` **close_scene**\ (\ ) :ref:`🔗` + +关闭当前活动的场景，关闭过程中忽略未保存的更改。成功时返回 :ref:`@GlobalScope.OK`\ ，如果没有可关闭的场景则返回 :ref:`@GlobalScope.ERR_DOES_NOT_EXIST`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_edit_node: .. rst-class:: classref-method @@ -371,9 +387,9 @@ Godot 编辑器的接口。 :ref:`float` **get_editor_scale**\ (\ ) |const| :ref:`🔗` -返回编辑器用户 UI 的实际比例（\ ``1.0`` 表示比例为 100%）。这可以用来调整由插件添加的用户 UI 的位置和尺寸。 +返回编辑器 UI 的实际缩放（\ ``1.0`` 表示缩放为 100%）。可以用来调整由插件添加的用户 UI 的位置和尺寸。 -\ **注意：**\ 这个值是通过 ``interface/editor/display_scale`` 和 ``interface/editor/custom_display_scale`` 编辑器设置项来设置。编辑器必须重新启动才能正确应用这些变化。 +\ **注意：**\ 这个值是通过 :ref:`EditorSettings.interface/editor/display_scale` 和 :ref:`EditorSettings.interface/editor/custom_display_scale` 来设置。编辑器必须重新启动才能正确应用这些变化。 .. rst-class:: classref-item-separator @@ -481,13 +497,25 @@ Godot 编辑器的接口。 ---- +.. _class_EditorInterface_method_get_open_scene_roots: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Node`\] **get_open_scene_roots**\ (\ ) |const| :ref:`🔗` + +返回包含当前所有已打开场景的根节点的数组。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_get_open_scenes: .. rst-class:: classref-method :ref:`PackedStringArray` **get_open_scenes**\ (\ ) |const| :ref:`🔗` -返回包含当前打开的场景的文件路径的数组 :ref:`Array`\ 。 +返回包含当前所有已打开场景的文件路径的数组。 .. rst-class:: classref-item-separator @@ -802,7 +830,7 @@ Godot 编辑器的接口。 func _ready(): if Engine.is_editor_hint(): EditorInterface.popup_node_selector(_on_node_selected, ["Button"]) - + func _on_node_selected(node_path): if node_path.is_empty(): print("节点选择已取消") @@ -826,7 +854,7 @@ Godot 编辑器的接口。 func _ready(): if Engine.is_editor_hint(): EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT]) - + func _on_property_selected(property_path): if property_path.is_empty(): print("属性选择已取消") @@ -903,7 +931,7 @@ Godot 编辑器的接口。 |void| **save_scene_as**\ (\ path\: :ref:`String`, with_preview\: :ref:`bool` = true\ ) :ref:`🔗` -将当前活动场景保存为 ``path`` 处的文件。 +将当前活动的场景保存为位于 ``path`` 的文件。 .. rst-class:: classref-item-separator @@ -943,7 +971,7 @@ Godot 编辑器的接口。 |void| **set_main_screen_editor**\ (\ name\: :ref:`String`\ ) :ref:`🔗` -将编辑器的当前主屏幕设置为 ``name`` 中指定的屏幕。\ ``name`` 必须与相关选项卡的文本完全匹配（\ ``2D``\ 、\ ``3D``\ 、\ ``Script``\ 、\ ``AssetLib``\ ）。 +将编辑器的当前主屏幕设置为 ``name`` 中指定的屏幕。\ ``name`` 必须与相关选项卡的文本完全匹配（默认选项卡为 ``2D``\ 、\ ``3D``\ 、\ ``Script``\ 、\ ``Game``\ 、\ ``AssetLib``\ ）。 .. rst-class:: classref-item-separator @@ -970,6 +998,7 @@ Godot 编辑器的接口。 停止当前正在播放的场景。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editornode3dgizmo.rst b/classes/zh_CN/class_editornode3dgizmo.rst index 7b7c7fb87e..f058dcc9fe 100644 --- a/classes/zh_CN/class_editornode3dgizmo.rst +++ b/classes/zh_CN/class_editornode3dgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorNode3DGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorNode3DGizmo.xml. .. _class_EditorNode3DGizmo: @@ -19,7 +19,7 @@ EditorNode3DGizmo 描述 ---- -小工具可用于为 :ref:`Node3D` 对象提供自定义可视化和编辑功能（控柄和子小工具）。可以被重写以创建自定义小工具，但对于简单的小工具而言，通常建议创建 :ref:`EditorNode3DGizmoPlugin`\ 。 +可用于为 :ref:`Node3D` 对象提供自定义可视化和编辑功能（控柄和子小工具）的小工具。可以被覆盖以创建自定义小工具，但对于简单的小工具而言，通常建议创建 :ref:`EditorNode3DGizmoPlugin`\ 。 .. rst-class:: classref-reftable-group @@ -407,6 +407,7 @@ EditorNode3DGizmo 设置该小工具参考的 :ref:`Node3D` 节点。\ ``node`` 必须继承自 :ref:`Node3D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editornode3dgizmoplugin.rst b/classes/zh_CN/class_editornode3dgizmoplugin.rst index cd08a8db11..f0258dbea4 100644 --- a/classes/zh_CN/class_editornode3dgizmoplugin.rst +++ b/classes/zh_CN/class_editornode3dgizmoplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorNode3DGizmoPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorNode3DGizmoPlugin.xml. .. _class_EditorNode3DGizmoPlugin: @@ -390,6 +390,7 @@ EditorNode3DGizmoPlugin 从内部材质列表中获取材质。如果提供了一个 :ref:`EditorNode3DGizmo`\ ，它将尝试获取相应的变体（选定的和/或可编辑的）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorpaths.rst b/classes/zh_CN/class_editorpaths.rst index cddc4a3b1e..7d5b014770 100644 --- a/classes/zh_CN/class_editorpaths.rst +++ b/classes/zh_CN/class_editorpaths.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorPaths.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorPaths.xml. .. _class_EditorPaths: @@ -164,6 +164,7 @@ EditorPaths \ **注意：**\ Godot 的 Steam 版本默认使用自包含模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorplugin.rst b/classes/zh_CN/class_editorplugin.rst index 11c27b626f..e32ce61a66 100644 --- a/classes/zh_CN/class_editorplugin.rst +++ b/classes/zh_CN/class_editorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorPlugin.xml. .. _class_EditorPlugin: @@ -203,7 +203,7 @@ EditorPlugin **main_screen_changed**\ (\ screen_name\: :ref:`String`\ ) :ref:`🔗` -当用户改变工作空间（\ **2D**\ 、\ **3D**\ 、\ **Script**\ 、\ **AssetLib**\ ）时发出。也适用于由插件定义的自定义屏幕。 +当用户改变工作空间（\ **2D**\ 、\ **3D**\ 、\ **脚本**\ 、\ **游戏**\ 、\ **资产库**\ ）时发出。也适用于由插件定义的自定义屏幕。 .. rst-class:: classref-item-separator @@ -587,7 +587,7 @@ enum **AfterGUIInput**: :ref:`🔗` |void| **_forward_3d_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` -当 3D 编辑器的视口更新时由引擎调用。将 ``overlay`` :ref:`Control` 用于绘制。可以通过调用 :ref:`update_overlays()` 手动更新该视口。 +当 3D 编辑器的视口更新时由引擎调用。\ ``viewport_control`` 覆盖在视口上方，可以用于绘制。可以通过调用 :ref:`update_overlays()` 手动更新该视口。 .. tabs:: @@ -597,7 +597,7 @@ enum **AfterGUIInput**: :ref:`🔗` func _forward_3d_draw_over_viewport(overlay): # 在光标位置画一个圆。 overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE) - + func _forward_3d_gui_input(camera, event): if event is InputEventMouseMotion: # 当光标被移动时，重绘视口。 @@ -612,7 +612,7 @@ enum **AfterGUIInput**: :ref:`🔗` // 在光标位置画一个圆。 viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White); } - + public override EditorPlugin.AfterGuiInput _Forward3DGuiInput(Camera3D viewportCamera, InputEvent @event) { if (@event is InputEventMouseMotion) @@ -702,7 +702,7 @@ enum **AfterGUIInput**: :ref:`🔗` |void| **_forward_canvas_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` -当 2D 编辑器的视口更新时由引擎调用。将 ``overlay`` :ref:`Control` 用于绘制。可以通过调用 :ref:`update_overlays()` 手动更新该视口。 +当 2D 编辑器的视口更新时由引擎调用。\ ``viewport_control`` 覆盖在视口上方，可以用于绘制。可以通过调用 :ref:`update_overlays()` 手动更新该视口。 .. tabs:: @@ -712,7 +712,7 @@ enum **AfterGUIInput**: :ref:`🔗` func _forward_canvas_draw_over_viewport(overlay): # 在光标位置画一个圆。 overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE) - + func _forward_canvas_gui_input(event): if event is InputEventMouseMotion: # 当光标被移动时，重绘视口。 @@ -727,7 +727,7 @@ enum **AfterGUIInput**: :ref:`🔗` // 在光标位置画一个圆。 viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White); } - + public override bool _ForwardCanvasGuiInput(InputEvent @event) { if (@event is InputEventMouseMotion) @@ -835,9 +835,9 @@ enum **AfterGUIInput**: :ref:`🔗` :ref:`Texture2D` **_get_plugin_icon**\ (\ ) |virtual| |const| :ref:`🔗` -在插件中覆盖该方法，以返回一个 :ref:`Texture2D` 以便为插件提供一个图标。 +在插件中覆盖该方法，返回插件图标的 :ref:`Texture2D`\ 。 -对于主界面插件，它出现在屏幕顶部，“2D”、“3D”、“脚本”和 “AssetLib” 按钮的右侧。 +对于主界面插件而言，图标出现在屏幕顶部，在“2D”“3D”“脚本”“游戏”“资产库”按钮的右侧。 理想情况下，插件图标应为透明背景的白色，大小为 16×16 像素。 @@ -847,18 +847,18 @@ enum **AfterGUIInput**: :ref:`🔗` .. code-tab:: gdscript func _get_plugin_icon(): - # 你可以使用一个自定义的图标： + # 你可以使用自定义的图标： return preload("res://addons/my_plugin/my_plugin_icon.svg") - # 或者使用一个内置的图标： + # 或者使用内置的图标： return EditorInterface.get_editor_theme().get_icon("Node", "EditorIcons") .. code-tab:: csharp public override Texture2D _GetPluginIcon() { - // 你可以使用一个自定义的图标： + // 你可以使用自定义的图标： return ResourceLoader.Load("res://addons/my_plugin/my_plugin_icon.svg"); - // 或者使用一个内置的图标： + // 或者使用内置的图标： return EditorInterface.Singleton.GetEditorTheme().GetIcon("Node", "EditorIcons"); } @@ -874,9 +874,9 @@ enum **AfterGUIInput**: :ref:`🔗` :ref:`String` **_get_plugin_name**\ (\ ) |virtual| |const| :ref:`🔗` -在插件中覆盖该方法，以在 Godot 编辑器中显示时提供该插件的名称。 +在插件中覆盖该方法，提供在 Godot 编辑器中显示时的名称。 -对于主屏幕插件，它显示在屏幕顶部，在“2D”“3D”“脚本”“AssetLib”按钮的右侧。 +对于主屏幕插件，它显示在屏幕顶部，在“2D”“3D”“脚本”“游戏”“资产库”按钮的右侧。 .. rst-class:: classref-item-separator @@ -899,7 +899,7 @@ enum **AfterGUIInput**: :ref:`🔗` :: func _get_state(): - var state = {"zoom": zoom, "preferred_color": my_color} + var state = { "zoom": zoom, "preferred_color": my_color } return state .. rst-class:: classref-item-separator @@ -923,12 +923,12 @@ enum **AfterGUIInput**: :ref:`🔗` func _get_unsaved_status(for_scene): if not unsaved: return "" - + if for_scene.is_empty(): return "Save changes in MyCustomPlugin before closing?" else: return "Scene %s has changes from MyCustomPlugin. Save before closing?" % for_scene.get_file() - + func _save_external_data(): unsaved = false @@ -984,7 +984,7 @@ enum **AfterGUIInput**: :ref:`🔗` :ref:`bool` **_has_main_screen**\ (\ ) |virtual| |const| :ref:`🔗` -如果这是一个主屏幕编辑器插件，则返回 ``true``\ （它与 **2D**\ 、\ **3D**\ 、\ **Script** 和 **AssetLib** 一起进入工作区选择器）。 +如果这是主屏幕编辑器插件，则返回 ``true``\ （它与 **2D**\ 、\ **3D**\ 、\ **脚本**\ 、\ **游戏**\ 、\ **资产库**\ 一起进入工作区选择器）。 当该插件的工作区被选中时，其他主屏幕插件将被隐藏，但你的插件不会自动出现。它需要被添加为 :ref:`EditorInterface.get_editor_main_screen()` 的子节点，并在 :ref:`_make_visible()` 中使其可见。 @@ -993,21 +993,21 @@ enum **AfterGUIInput**: :ref:`🔗` :: var plugin_control - + func _enter_tree(): plugin_control = preload("my_plugin_control.tscn").instantiate() EditorInterface.get_editor_main_screen().add_child(plugin_control) plugin_control.hide() - + func _has_main_screen(): return true - + func _make_visible(visible): plugin_control.visible = visible - + func _get_plugin_name(): return "My Super Cool Plugin 3000" - + func _get_plugin_icon(): return EditorInterface.get_editor_theme().get_icon("Node", "EditorIcons") @@ -1099,7 +1099,7 @@ enum **AfterGUIInput**: :ref:`🔗` 将插件添加至上下文菜单。\ ``slot`` 为添加插件的上下文菜单。 -可用上下文菜单见 :ref:`ContextMenuSlot`\ 。插件的实例只能属于单个上下文菜单槽。 +\ **注意：**\ 插件的实例只能属于单个上下文菜单槽。 .. rst-class:: classref-item-separator @@ -1125,7 +1125,7 @@ enum **AfterGUIInput**: :ref:`🔗` |void| **add_control_to_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) :ref:`🔗` -将自定义控件添加到容器中（见 :ref:`CustomControlContainer`\ ）。在编辑器用户界面中，有许多位置可以添加自定义控件。 +将自定义控件添加到编辑器 UI 中的某个容器。 请记住，必须自己管理你的自定义控件的可见性（并且很可能在添加后隐藏它）。 @@ -1141,13 +1141,13 @@ enum **AfterGUIInput**: :ref:`🔗` |void| **add_control_to_dock**\ (\ slot\: :ref:`DockSlot`, control\: :ref:`Control`, shortcut\: :ref:`Shortcut` = null\ ) :ref:`🔗` -将控件添加到特定的停靠槽位（选项见 :ref:`DockSlot`\ ）。 +将控件添加到特定的停靠面板槽位。 如果重新放置了停靠面板，并且只要该插件处于活动状态，编辑器就会在以后的会话中保存停靠面板的位置。 停用插件后，请确保使用 :ref:`remove_control_from_docks()` 移除自定义控件，并使用 :ref:`Node.queue_free()` 将其释放。 -你还可以指定快捷键参数。如果停靠面板位于底部面板，那么按下该快捷键就会切换面板的可见性（否则快捷键不会影响面板）。示例见“编辑器设置”中的默认编辑器底部面板快捷键。按照惯例都使用了 :kbd:`Alt` 修饰键。 +你还可以指定快捷键参数。按下该快捷键就会打开并聚焦该面板。 .. rst-class:: classref-item-separator @@ -1248,10 +1248,10 @@ enum **AfterGUIInput**: :ref:`🔗` const MyInspectorPlugin = preload("res://addons/your_addon/path/to/your/script.gd") var inspector_plugin = MyInspectorPlugin.new() - + func _enter_tree(): add_inspector_plugin(inspector_plugin) - + func _exit_tree(): remove_inspector_plugin(inspector_plugin) @@ -1730,6 +1730,7 @@ enum **AfterGUIInput**: :ref:`🔗` 更新 2D 和 3D 编辑器视口的叠加层。会导致方法 :ref:`_forward_canvas_draw_over_viewport()`\ 、\ :ref:`_forward_canvas_force_draw_over_viewport()`\ 、\ :ref:`_forward_3d_draw_over_viewport()` 和 :ref:`_forward_3d_force_draw_over_viewport()` 被调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorproperty.rst b/classes/zh_CN/class_editorproperty.rst index 070e8a843c..180dd0ef78 100644 --- a/classes/zh_CN/class_editorproperty.rst +++ b/classes/zh_CN/class_editorproperty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorProperty.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorProperty.xml. .. _class_EditorProperty: @@ -29,31 +29,33 @@ EditorProperty .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checkable` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checked` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`deletable` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_background` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_label` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_warning` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`keying` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`label` | ``""`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`name_split_ratio` | ``0.5`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`read_only` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`selectable` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`use_folding` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`checkable` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`checked` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`deletable` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_background` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_label` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_warning` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`keying` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`String` | :ref:`label` | ``""`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | :ref:`name_split_ratio` | ``0.5`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`read_only` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`selectable` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_folding` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -208,6 +210,18 @@ EditorProperty ---- +.. _class_EditorProperty_signal_property_overridden: + +.. rst-class:: classref-signal + +**property_overridden**\ (\ ) :ref:`🔗` + +请求对当前项目的设置进行覆盖时发出。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorProperty_signal_property_pinned: .. rst-class:: classref-signal @@ -313,7 +327,7 @@ EditorProperty - |void| **set_draw_background**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_background**\ (\ ) -用于检查器，该属性绘制标签时设置为 ``true``\ 。 +用于检查器，该属性绘制背景时设置为 ``true``\ 。 .. rst-class:: classref-item-separator @@ -330,7 +344,7 @@ EditorProperty - |void| **set_draw_label**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_label**\ (\ ) -用于检查器，该属性绘制背景时设置为 ``true``\ 。 +用于检查器，该属性绘制标签时设置为 ``true``\ 。 .. rst-class:: classref-item-separator @@ -526,7 +540,9 @@ EditorProperty :ref:`Object` **get_edited_object**\ (\ ) :ref:`🔗` -获取被编辑的对象。 +返回编辑的对象。 + +\ **注意：**\ 如果编辑器尚未与属性关联则会返回 ``null``\ 。不过能够\ *保证*\ 在 :ref:`_update_property()` 和 :ref:`_set_read_only()` 中该值非 ``null``\ 。 .. rst-class:: classref-item-separator @@ -538,7 +554,9 @@ EditorProperty :ref:`StringName` **get_edited_property**\ (\ ) |const| :ref:`🔗` -获取被编辑的属性。如果你的编辑器适用于单个属性（通过 :ref:`EditorInspectorPlugin._parse_property()` 添加），则返回该属性。 +返回编辑的属性。如果你的编辑器适用于单个属性（通过 :ref:`EditorInspectorPlugin._parse_property()` 添加），那么就会返回该属性。 + +\ **注意：**\ 如果编辑器尚未与属性关联则会返回 ``null``\ 。不过能够\ *保证*\ 在 :ref:`_update_property()` 和 :ref:`_set_read_only()` 中该值非 ``null``\ 。 .. rst-class:: classref-item-separator @@ -613,6 +631,7 @@ EditorProperty 强制刷新属性显示。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorresourceconversionplugin.rst b/classes/zh_CN/class_editorresourceconversionplugin.rst index d20c751e2f..a90743d617 100644 --- a/classes/zh_CN/class_editorresourceconversionplugin.rst +++ b/classes/zh_CN/class_editorresourceconversionplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorResourceConversionPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourceConversionPlugin.xml. .. _class_EditorResourceConversionPlugin: @@ -29,13 +29,13 @@ EditorResourceConversionPlugin .. code-tab:: gdscript extends EditorResourceConversionPlugin - + func _handles(resource: Resource): return resource is ImageTexture - + func _converts_to(): return "PortableCompressedTexture2D" - + func _convert(itex: Resource): var ptex = PortableCompressedTexture2D.new() ptex.create_from_image(itex.get_image(), PortableCompressedTexture2D.COMPRESSION_MODE_LOSSLESS) @@ -103,6 +103,7 @@ EditorResourceConversionPlugin 调用以确定特定 :ref:`Resource` 是否可以通过该插件转换为目标资源类型。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorresourcepicker.rst b/classes/zh_CN/class_editorresourcepicker.rst index c3ed2a807d..a3608a7a80 100644 --- a/classes/zh_CN/class_editorresourcepicker.rst +++ b/classes/zh_CN/class_editorresourcepicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorResourcePicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePicker.xml. .. _class_EditorResourcePicker: @@ -219,6 +219,7 @@ Godot 编辑器用于选择 :ref:`Resource` 类型属性的控 设置主按钮的切换模式状态。只有当 :ref:`toggle_mode` 被设置为 ``true`` 时才起作用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorresourcepreview.rst b/classes/zh_CN/class_editorresourcepreview.rst index 0287377a94..7802c1b6f7 100644 --- a/classes/zh_CN/class_editorresourcepreview.rst +++ b/classes/zh_CN/class_editorresourcepreview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorResourcePreview.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreview.xml. .. _class_EditorResourcePreview: @@ -130,6 +130,7 @@ EditorResourcePreview 移除自定义预览生成器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorresourcepreviewgenerator.rst b/classes/zh_CN/class_editorresourcepreviewgenerator.rst index 2f36d6e876..cce6fa6de5 100644 --- a/classes/zh_CN/class_editorresourcepreviewgenerator.rst +++ b/classes/zh_CN/class_editorresourcepreviewgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorResourcePreviewGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreviewGenerator.xml. .. _class_EditorResourcePreviewGenerator: @@ -123,6 +123,7 @@ EditorResourcePreviewGenerator 如果你的生成器支持类型为 ``type`` 的资源，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorresourcetooltipplugin.rst b/classes/zh_CN/class_editorresourcetooltipplugin.rst index fa45399c2a..159ed16641 100644 --- a/classes/zh_CN/class_editorresourcetooltipplugin.rst +++ b/classes/zh_CN/class_editorresourcetooltipplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorResourceTooltipPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourceTooltipPlugin.xml. .. _class_EditorResourceTooltipPlugin: @@ -97,6 +97,7 @@ EditorResourceTooltipPlugin 为给定的 :ref:`TextureRect` 请求缩略图。缩略图使用 :ref:`EditorResourcePreview` 异步创建，会在可用时自动设置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsceneformatimporter.rst b/classes/zh_CN/class_editorsceneformatimporter.rst index cb067caf94..6e2c02d783 100644 --- a/classes/zh_CN/class_editorsceneformatimporter.rst +++ b/classes/zh_CN/class_editorsceneformatimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorSceneFormatImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSceneFormatImporter.xml. .. _class_EditorSceneFormatImporter: @@ -222,6 +222,7 @@ EditorSceneFormatImporter 添加特定的导入选项。该函数只能在 :ref:`_get_import_options()` 中调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsceneformatimporterblend.rst b/classes/zh_CN/class_editorsceneformatimporterblend.rst index 4df059a027..8356cbb803 100644 --- a/classes/zh_CN/class_editorsceneformatimporterblend.rst +++ b/classes/zh_CN/class_editorsceneformatimporterblend.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/EditorSceneFormatImporterBlend.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/EditorSceneFormatImporterBlend.xml. .. _class_EditorSceneFormatImporterBlend: @@ -21,7 +21,7 @@ Blender 的 ``.blend`` 场景文件格式的导入器。 通过 glTF 2.0 3D 导入管道导入使用 ``.blend`` 文件格式的 Blender 场景。该导入器要求用户安装 Blender，以便将场景导出为 glTF 2.0。 -Blender 可执行文件的位置是通过 ``filesystem/import/blender/blender_path`` 编辑器设置来设置的。 +Blender 可执行文件的位置是通过 :ref:`EditorSettings.filesystem/import/blender/blender_path` 来设置的。 该导入器仅在启用 :ref:`ProjectSettings.filesystem/import/blender/enabled` 时使用，否则不会导入项目文件夹中存在的 ``.blend`` 文件。 @@ -30,6 +30,7 @@ Blend 导入需要 Blender 3.0。 在内部，EditorSceneFormatImporterBlend 使用 Blender glTF“使用原始”模式来引用外部纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsceneformatimporterfbx2gltf.rst b/classes/zh_CN/class_editorsceneformatimporterfbx2gltf.rst index c17c887dae..f27693450d 100644 --- a/classes/zh_CN/class_editorsceneformatimporterfbx2gltf.rst +++ b/classes/zh_CN/class_editorsceneformatimporterfbx2gltf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/fbx/doc_classes/EditorSceneFormatImporterFBX2GLTF.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/fbx/doc_classes/EditorSceneFormatImporterFBX2GLTF.xml. .. _class_EditorSceneFormatImporterFBX2GLTF: @@ -26,6 +26,7 @@ FBX2glTF 可执行文件的位置通过 :ref:`EditorSettings.filesystem/import/f 仅当 :ref:`ProjectSettings.filesystem/import/fbx2gltf/enabled` 设置为 ``true`` 时，才使用该导入器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsceneformatimportergltf.rst b/classes/zh_CN/class_editorsceneformatimportergltf.rst index ccea1f53e5..3d3619aec7 100644 --- a/classes/zh_CN/class_editorsceneformatimportergltf.rst +++ b/classes/zh_CN/class_editorsceneformatimportergltf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/EditorSceneFormatImporterGLTF.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/EditorSceneFormatImporterGLTF.xml. .. _class_EditorSceneFormatImporterGLTF: @@ -17,6 +17,7 @@ EditorSceneFormatImporterGLTF 该类目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsceneformatimporterufbx.rst b/classes/zh_CN/class_editorsceneformatimporterufbx.rst index 4c608c7cf8..d2ddc68d98 100644 --- a/classes/zh_CN/class_editorsceneformatimporterufbx.rst +++ b/classes/zh_CN/class_editorsceneformatimporterufbx.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/fbx/doc_classes/EditorSceneFormatImporterUFBX.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/fbx/doc_classes/EditorSceneFormatImporterUFBX.xml. .. _class_EditorSceneFormatImporterUFBX: @@ -24,6 +24,7 @@ EditorSceneFormatImporterUFBX EditorSceneFormatImporterUFBX 旨在加载 FBX 文件，并支持从版本 3000 开始的二进制和 ASCII FBX 文件。该类支持各种 3D 对象类型，例如网格、皮肤、混合形状、材质和绑定信息。该类旨在与官方 FBX SDK 功能相同，并支持 FBX 7.4 规范。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorscenepostimport.rst b/classes/zh_CN/class_editorscenepostimport.rst index 14bffd7786..4b11b11a53 100644 --- a/classes/zh_CN/class_editorscenepostimport.rst +++ b/classes/zh_CN/class_editorscenepostimport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorScenePostImport.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScenePostImport.xml. .. _class_EditorScenePostImport: @@ -30,14 +30,14 @@ EditorScenePostImport @tool # 需要它才能在编辑器中运行。 extends EditorScenePostImport - + # 该示例更改所有节点名称。 # 在导入场景并获取根节点后立即调用。 func _post_import(scene): # 将所有节点名称更改为 “modified_[oldnodename]” iterate(scene) return scene # 记得返回导入的场景 - + func iterate(node): if node != null: node.name = "modified_" + node.name @@ -47,7 +47,7 @@ EditorScenePostImport .. code-tab:: csharp using Godot; - + // 该示例更改所有节点名称。 // 在导入场景并获取根节点后立即调用。 [Tool] @@ -59,7 +59,7 @@ EditorScenePostImport Iterate(scene); return scene; // 记得返回导入的场景 } - + public void Iterate(Node node) { if (node != null) @@ -126,6 +126,7 @@ EditorScenePostImport 返回导入的源文件路径（如\ ``res://scene.dae``\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorscenepostimportplugin.rst b/classes/zh_CN/class_editorscenepostimportplugin.rst index cb0d0ee9d9..7a0315abc2 100644 --- a/classes/zh_CN/class_editorscenepostimportplugin.rst +++ b/classes/zh_CN/class_editorscenepostimportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorScenePostImportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScenePostImportPlugin.xml. .. _class_EditorScenePostImportPlugin: @@ -304,6 +304,7 @@ enum **InternalImportCategory**: :ref:`🔗` 方法的脚本可以在编辑器运行时通过脚本编辑器的\ **文件 > 运行**\ 菜单选项（或按 :kbd:`Ctrl + Shift + X`\ ）执行。这对于向 Godot 添加自定义的编辑内功能很有用。对于更复杂的添加，请考虑改用 :ref:`EditorPlugin`\ 。 +如果扩展该类的脚本存在全局类名，则会包含在编辑器的命令面板中。 + \ **注意：**\ 扩展脚本需要启用 ``tool`` 工具模式。 \ **示例：**\ 运行下面的脚本会输出“Godot 编辑器向你问好！”： @@ -32,14 +34,14 @@ EditorScript @tool extends EditorScript - + func _run(): print("Hello from the Godot Editor!") .. code-tab:: csharp using Godot; - + [Tool] public partial class HelloEditor : EditorScript { @@ -51,8 +53,6 @@ EditorScript -\ **注意：**\ 脚本在编辑器上下文中运行，这意味着输出在使用编辑器（stdout）启动的控制台窗口中可见，而不是通常的 Godot **输出**\ 停靠面板。 - \ **注意：**\ EditorScript 是 :ref:`RefCounted`\ ，这意味着它不再被引用时会被销毁。如果没有对脚本的引用，这可能会在异步操作期间导致错误。 .. rst-class:: classref-reftable-group @@ -64,7 +64,7 @@ EditorScript :widths: auto +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_run`\ (\ ) |virtual| | + | |void| | :ref:`_run`\ (\ ) |virtual| |required| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_root_node`\ (\ node\: :ref:`Node`\ ) | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ @@ -86,7 +86,7 @@ EditorScript .. rst-class:: classref-method -|void| **_run**\ (\ ) |virtual| :ref:`🔗` +|void| **_run**\ (\ ) |virtual| |required| :ref:`🔗` 当使用\ **文件 > 运行**\ 时，此方法由编辑器执行。 @@ -129,6 +129,7 @@ EditorScript 返回正在编辑的（当前）场景的根 :ref:`Node`\ 。相当于 :ref:`EditorInterface.get_edited_scene_root()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorscriptpicker.rst b/classes/zh_CN/class_editorscriptpicker.rst index b17c14ce8e..9010266168 100644 --- a/classes/zh_CN/class_editorscriptpicker.rst +++ b/classes/zh_CN/class_editorscriptpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorScriptPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScriptPicker.xml. .. _class_EditorScriptPicker: @@ -58,6 +58,7 @@ Godot 编辑器的控件，用于选择节点 :ref:`Node` 的脚本 持有被编辑资源的脚本属性的所有者 :ref:`Node`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorselection.rst b/classes/zh_CN/class_editorselection.rst index 75704d3f2b..f9f62a8fce 100644 --- a/classes/zh_CN/class_editorselection.rst +++ b/classes/zh_CN/class_editorselection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorSelection.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSelection.xml. .. _class_EditorSelection: @@ -38,6 +38,8 @@ EditorSelection +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Node`\] | :ref:`get_selected_nodes`\ (\ ) | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_top_selected_nodes`\ (\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Node`\] | :ref:`get_transformable_selected_nodes`\ (\ ) | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_node`\ (\ node\: :ref:`Node`\ ) | @@ -107,13 +109,29 @@ EditorSelection ---- +.. _class_EditorSelection_method_get_top_selected_nodes: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Node`\] **get_top_selected_nodes**\ (\ ) :ref:`🔗` + +返回仅包含顶层选定节点的列表，不包括任何子节点。适用于执行变换操作（移动、旋转等）。 + +例如节点 A 有一个子节点 B、一个同级节点 C，如果选中这三个节点，那么该方法只会返回 A 和 C。更改 A 的全局变换将影响 B 的全局变换，因此不需要单独更改 B。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSelection_method_get_transformable_selected_nodes: .. rst-class:: classref-method :ref:`Array`\[:ref:`Node`\] **get_transformable_selected_nodes**\ (\ ) :ref:`🔗` -返回选定节点的列表，针对变换操作（即移动它们、旋转等）进行了优化。该列表可用于避免被选择的节点同时也是子节点/孙节点的情况。 +**已弃用：** Use :ref:`get_top_selected_nodes()` instead. + +返回仅包含顶层选定节点的列表，不包括任何子节点。适用于执行变换操作（移动、旋转等）。见 :ref:`get_top_selected_nodes()`\ 。 .. rst-class:: classref-item-separator @@ -128,6 +146,7 @@ EditorSelection 从选择中删除一个节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsettings.rst b/classes/zh_CN/class_editorsettings.rst index 171cb7b223..c68533e975 100644 --- a/classes/zh_CN/class_editorsettings.rst +++ b/classes/zh_CN/class_editorsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSettings.xml. .. _class_EditorSettings: @@ -65,6 +65,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debugger/auto_switch_to_stack_trace` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/max_node_selection` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debugger/profile_native_calls` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | @@ -89,6 +91,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/accessibility_warnings` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/ask_before_deleting_related_animation_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/ask_before_revoking_unique_name` | @@ -119,6 +123,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/2d/guides_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/2d/ruler_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | @@ -127,6 +133,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/2d/zoom_speed_factor` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/active_selection_box_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d/default_fov` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d/default_z_far` | @@ -261,16 +269,24 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/3d_gizmos/gizmo_settings/bone_shape` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d_gizmos/gizmo_settings/lightmap_gi_probe_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/confirm_insert_track` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/animation/default_animation_step` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_fps_compatibility` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/animation/default_fps_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | @@ -301,6 +317,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/zoom_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/polygon_editor/auto_bake_delay` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | @@ -421,6 +439,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input/buffering/use_accumulated_input` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/accessibility/accessibility_support` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | @@ -435,6 +455,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/code_font_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/collapse_main_menu` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interface/editor/custom_display_scale` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/display_scale` | @@ -487,6 +509,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/single_window_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/tablet_driver` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | @@ -505,6 +529,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/color_picker_show_intensity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/default_color_picker_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/default_color_picker_shape` | @@ -585,11 +611,13 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | + | :ref:`bool` | :ref:`interface/touchscreen/enable_touch_optimizations` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/connection/engine_version_update_mode` | + | :ref:`int` | :ref:`interface/touchscreen/touch_actions_panel` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/connection/check_for_updates` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/connection/network_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -645,6 +673,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/appearance/caret/type` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/enable_inline_color_picker` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` | @@ -685,6 +715,8 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/drop_preload_resources_as_uid` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/open_dominant_script_on_scene_change` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | @@ -801,6 +833,18 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_markers/critical_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/theme/highlighting/comment_markers/critical_list` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_markers/notice_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/theme/highlighting/comment_markers/notice_list` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_markers/warning_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/theme/highlighting/comment_markers/warning_list` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_background_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_existing_color` | @@ -827,6 +871,18 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/function_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/annotation_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/function_definition_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/global_function_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/node_path_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/node_reference_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/gdscript/string_name_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/keyword_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_length_guideline_color` | @@ -857,9 +913,9 @@ EditorSettings +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | + | :ref:`Color` | :ref:`text_editor/theme/highlighting/warning_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/theme/line_spacing` | + | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`version_control/ssh_private_key_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -991,6 +1047,20 @@ EditorSettings ---- +.. _class_EditorSettings_property_debugger/max_node_selection: + +.. rst-class:: classref-property + +:ref:`int` **debugger/max_node_selection** :ref:`🔗` + +一次性最多可以选中多少远程节点。 + +\ **警告：**\ 不建议调大，选中太多节点会导致对远程属性的编辑和查看变得不稳定。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_debugger/profile_native_calls: .. rst-class:: classref-property @@ -1139,6 +1209,18 @@ EditorSettings ---- +.. _class_EditorSettings_property_docks/scene_tree/accessibility_warnings: + +.. rst-class:: classref-property + +:ref:`bool` **docks/scene_tree/accessibility_warnings** :ref:`🔗` + +如果为\ ``true``\ ，无障碍相关的警告会和其他配置警告一同显示。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_docks/scene_tree/ask_before_deleting_related_animation_tracks: .. rst-class:: classref-property @@ -1323,6 +1405,18 @@ EditorSettings ---- +.. _class_EditorSettings_property_editors/2d/ruler_width: + +.. rst-class:: classref-property + +:ref:`float` **editors/2d/ruler_width** :ref:`🔗` + +2D 编辑器坐标标尺的粗细。增大该值也会增大标尺字体的大小，提升使用较低编辑器缩放时的可读性。编辑器可能会强制设置最小尺寸，保持标尺数字可见。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/2d/smart_snapping_line_color: .. rst-class:: classref-property @@ -1371,6 +1465,20 @@ EditorSettings ---- +.. _class_EditorSettings_property_editors/3d/active_selection_box_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d/active_selection_box_color** :ref:`🔗` + +用于 3D 编辑器视口中包围选定节点的活动选择框的颜色。颜色的 Alpha 通道会影响选择框的不透明度。 + +\ **注意：**\ “活动”一词表示该对象是某些操作的主要选择依据。这是最后选中的 :ref:`Node3D`\ ，可以通过 :kbd:`Shift + 左键鼠标` 进行重新排序。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d/default_fov: .. rst-class:: classref-property @@ -2205,6 +2313,18 @@ CSG 节点（例如 :ref:`CSGShape3D` 和 :ref:`CSGBox3D` **editors/3d_gizmos/gizmo_settings/lightmap_gi_probe_size** :ref:`🔗` + +编辑 :ref:`LightmapGI` 和 :ref:`LightmapProbe` 节点时显示的探针小工具的大小。设为 ``0.0`` 时会隐藏 :ref:`LightmapGI` 的探针球和 :ref:`LightmapProbe` 的线框，但会保留 :ref:`LightmapGI` 中连接探针的线框和 :ref:`LightmapProbe` 的公告板图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size: .. rst-class:: classref-property @@ -2243,6 +2363,20 @@ CSG 节点（例如 :ref:`CSGShape3D` 和 :ref:`CSGBox3D` **editors/animation/default_animation_step** :ref:`🔗` + +在“动画”底部面板中新建 :ref:`Animation` 时使用的默认步长。只会影响 :ref:`AnimationPlayer` 中创建的第一个动画。默认情况下，其他新建的动画会使用上一个动画的步长。 + +这个值始终以秒为单位。如果你希望默认使用 ``10`` FPS，就需要将默认步长设置为 ``0.1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/animation/default_create_bezier_tracks: .. rst-class:: classref-property @@ -2267,6 +2401,30 @@ CSG 节点（例如 :ref:`CSGShape3D` 和 :ref:`CSGBox3D` **editors/animation/default_fps_compatibility** :ref:`🔗` + +控制 :ref:`AnimationPlayer` 在使用“Seconds”吸附模式时，是否吸附到最接近的整数 FPS。选择会记录在场景本地，该选项只用来确定场景本地状态尚不存在时的默认值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/animation/default_fps_mode: + +.. rst-class:: classref-property + +:ref:`int` **editors/animation/default_fps_mode** :ref:`🔗` + +:ref:`AnimationPlayer` 的默认步长模式（秒或 FPS）。选择会记录在场景本地，该选项只用来确定场景本地状态尚不存在时的默认值。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/animation/onion_layers_future_color: .. rst-class:: classref-property @@ -2455,6 +2613,18 @@ GridMap 网格调色板侧边面板的最小宽度。 ---- +.. _class_EditorSettings_property_editors/panning/zoom_style: + +.. rst-class:: classref-property + +:ref:`int` **editors/panning/zoom_style** :ref:`🔗` + +在任何编辑器中（除 3D 场景编辑器）通过移动鼠标进行拖动缩放时使用的鼠标光标移动方向。不会影响使用鼠标滚轮进行的缩放。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/polygon_editor/auto_bake_delay: .. rst-class:: classref-property @@ -3150,7 +3320,11 @@ Blender 进程的最大空闲运行时间（单位为秒）。 :ref:`bool` **filesystem/quick_open_dialog/enable_fuzzy_matching** :ref:`🔗` -如果为 ``true``\ ，则允许对搜索内容进行模糊匹配。 +如果为 ``true``\ ，则对话框中除了包含完全匹配的文件名外，还会包含近似匹配。 + +适用于在搜索查询中打错字的情况下也能查到正确的文件；例如搜索“nprmal”查到“normal”。另外还可以让你写更短的搜索查询；例如搜索“nml”也可以查到“normal”。 + +另见 :ref:`filesystem/quick_open_dialog/max_fuzzy_misses`\ 。 .. rst-class:: classref-item-separator @@ -3174,7 +3348,7 @@ Blender 进程的最大空闲运行时间（单位为秒）。 :ref:`int` **filesystem/quick_open_dialog/max_fuzzy_misses** :ref:`🔗` -启用模糊匹配时，匹配中允许缺失的查询字符的数量。例如使用默认值 2 时，\ ``foobar`` 能够匹配 ``foobur`` 和 ``foob``\ ，但无法匹配 ``foo``\ 。 +启用模糊匹配时，匹配中允许缺失的查询字符的数量。例如使用默认值 ``2`` 时，\ ``"normal"`` 能够匹配 ``"narmal"`` 和 ``"norma"``\ ，但无法匹配 ``"nor"``\ 。 .. rst-class:: classref-item-separator @@ -3250,6 +3424,26 @@ Blender 进程的最大空闲运行时间（单位为秒）。 ---- +.. _class_EditorSettings_property_interface/accessibility/accessibility_support: + +.. rst-class:: classref-property + +:ref:`int` **interface/accessibility/accessibility_support** :ref:`🔗` + +编辑器无障碍支持模式： + +- **Auto**\ （\ ``0``\ ）：启用无障碍支持，但只会在辅助应用（屏幕阅读器、盲文显示器等）处于活动状态时才会处理无障碍信息的更新（默认）。 + +- **Always Active**\ （\ ``1``\ ）：启用无障碍支持，无论当前辅助应用的状态都会处理无障碍信息的处理。 + +- **Disabled**\ （\ ``2``\ ）：完全禁用无障碍支持。 + +\ **注意：**\ Accessibility Insights for Windows、Accessibility Inspector（macOS）、AT-SPI 浏览器（Linux/BSD）等无障碍调试工具不算作辅助应用。要使用这些工具测试应用，请使用 **Always Active**\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/accept_dialog_cancel_ok_buttons: .. rst-class:: classref-property @@ -3258,11 +3452,11 @@ Blender 进程的最大空闲运行时间（单位为秒）。 如何在编辑器的 :ref:`AcceptDialog` 中定位取消和确定按钮。不同的平台有不同的标准行为，可以用这个设置来覆盖。如果你在 Windows 和 macOS/Linux 上都使用 Godot，而且你的 Godot 肌肉记忆比你的操作系统记忆更强，那么这一点很有用。 -- **Auto** 遵守平台约定：在 macOS 和 Linux 上取消在前，在 Windows 上确定在前。 +- **Auto** 遵守平台约定：Windows、KDE、LXQt 上确定在前，macOS 及其他 Linux 桌面上取消在前。 -- **Cancel First** 强制为取消/确定的顺序。 +- **Cancel First** 强制为取消、确定的顺序。 -- **OK First** 强制为确定/取消的顺序。 +- **OK First** 强制为确定、取消的顺序。 .. rst-class:: classref-item-separator @@ -3346,6 +3540,22 @@ Blender 进程的最大空闲运行时间（单位为秒）。 ---- +.. _class_EditorSettings_property_interface/editor/collapse_main_menu: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/collapse_main_menu** :ref:`🔗` + +如果为 ``true``\ ，则主菜单会折叠成一个 :ref:`MenuButton`\ 。 + +\ **注意：**\ 在 macOS 上，仅在 :ref:`interface/editor/use_embedded_menu` 为 ``true`` 时有效。 + +\ **注意：**\ 在 Android 编辑器中默认为 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/custom_display_scale: .. rst-class:: classref-property @@ -3408,7 +3618,7 @@ Blender 进程的最大空闲运行时间（单位为秒）。 :ref:`int` **interface/editor/editor_screen** :ref:`🔗` -用于显示编辑器的首选显示器。如果为 **Auto**\ ，则编辑器重启后会记住上一次显示的屏幕。 +用于显示编辑器的首选显示器。如果为 **Auto**\ ，则编辑器会在不同会话中记住上一次显示的屏幕。 .. rst-class:: classref-item-separator @@ -3540,7 +3750,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`int` **interface/editor/low_processor_mode_sleep_usec** :ref:`🔗` -启用低处理器使用模式时帧之间的睡眠时间（以微秒为单位）。更高的值将导致更低的 CPU/GPU 使用率，这可以延长笔记本电脑的电池寿命。但是，更高的值会导致编辑器的响应速度更慢。默认值设置为允许在高达 144 Hz 的显示器上实现最大流畅度。另见 :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec`\ 。 +编辑器中帧与帧之间的睡眠时间（单位为微秒）。值越高 CPU/GPU 占用率越低，可以延长笔记本电脑的电池寿命。但是，值越高编辑器的响应速度越慢。默认值设置为允许在高达 144 Hz 的显示器上实现最大流畅度。另见 :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec`\ 。 \ **注意：**\ 如果 :ref:`interface/editor/update_continuously` 为 ``true``\ ，则忽略该设置，因为启用该设置会禁用低处理器模式。 @@ -3556,6 +3766,8 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 用于编辑器界面的字体。必须是 :ref:`Font` 类型的资源，例如 ``.ttf`` 或 ``.otf`` 字体文件。 +\ **注意：**\ 如果提供的是可变字体，则会使用 400（普通）作为字重。 + .. rst-class:: classref-item-separator ---- @@ -3568,6 +3780,8 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 用于编辑器界面中粗体文本的字体。必须是 :ref:`Font` 类型的资源，例如 ``.ttf`` 或 ``.otf`` 字体文件。 +\ **注意：**\ 如果提供的是可变字体，则会使用 700（粗体）作为字重。 + .. rst-class:: classref-item-separator ---- @@ -3638,7 +3852,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`bool` **interface/editor/separate_distraction_mode** :ref:`🔗` -如果为 ``true``\ ，则编辑器的 Script 选项卡，将具有与 2D/3D/AssetLib 选项卡不同的干扰模式设置。如果为 ``false``\ ，无干扰模式切换在所有选项卡之间共享。 +如果为 ``true``\ ，则编辑器“脚本”选项卡的干扰模式设置独立于 2D、3D、资产库选项卡。如果为 ``false``\ ，则所有选项卡使用同一个无干扰模式开关。 .. rst-class:: classref-item-separator @@ -3696,6 +3910,18 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- +.. _class_EditorSettings_property_interface/editor/tablet_driver: + +.. rst-class:: classref-property + +:ref:`int` **interface/editor/tablet_driver** :ref:`🔗` + +覆盖编辑器使用的平板驱动。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/ui_layout_direction: .. rst-class:: classref-property @@ -3714,7 +3940,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`int` **interface/editor/unfocused_low_processor_mode_sleep_usec** :ref:`🔗` -当编辑器窗口未聚焦时，启用低处理器使用模式时帧之间的睡眠量（以微秒为单位）。更高的值将导致更低的 CPU/GPU 使用率，这可以延长笔记本电脑的电池寿命（如果编辑器必须连续重绘，还可以提高正在运行的项目的性能）。但是，更高的值会导致编辑器的响应速度变慢。默认值设置会在编辑器窗口未聚焦时，将编辑器限制为 20 FPS。另见 :ref:`interface/editor/low_processor_mode_sleep_usec`\ 。 +当编辑器窗口未聚焦时，启用低处理器使用模式时帧之间的睡眠量（以微秒为单位）。更高的值将导致更低的 CPU/GPU 使用率，这可以延长笔记本电脑的电池寿命（如果编辑器必须连续重绘，还可以提高正在运行的项目的性能）。但是，更高的值会导致编辑器的响应速度变慢。默认值设置会在编辑器窗口未聚焦时，将编辑器限制为 10 FPS。另见 :ref:`interface/editor/low_processor_mode_sleep_usec`\ 。 \ **注意：**\ 如果 :ref:`interface/editor/update_continuously` 为 ``true``\ ，则忽略该设置，因为启用该设置会禁用低处理器模式。 @@ -3808,7 +4034,21 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`bool` **interface/inspector/auto_unfold_foreign_scenes** :ref:`🔗` -如果为 ``true``\ ，则会在打开之前没有打开过的场景时，自动展开“检查器”面板中的属性分组。如果为 ``false``\ ，则默认折叠所有分组。 +如果为 ``true``\ ，则会在首次打开场景时自动展开“检查器”中包含被修改值的属性分类。只会影响尚未保存折叠首选项的场景，只会展开包含取值与默认值不同的属性的分组。 + +\ **注意：**\ 该设置仅在特定场合生效：打开从其他项目拿来的场景，或是新打开已包含被修改属性的场景（例如源自版本控制）。复制的场景是已知的，不受该设置的影响。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/color_picker_show_intensity: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/color_picker_show_intensity** :ref:`🔗` + +如果为 ``true``\ ，则编辑器中打开的 :ref:`ColorPicker` 会显示强度滑块。 .. rst-class:: classref-item-separator @@ -4336,13 +4576,13 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- -.. _class_EditorSettings_property_interface/touchscreen/increase_scrollbar_touch_area: +.. _class_EditorSettings_property_interface/touchscreen/enable_touch_optimizations: .. rst-class:: classref-property -:ref:`bool` **interface/touchscreen/increase_scrollbar_touch_area** :ref:`🔗` +:ref:`bool` **interface/touchscreen/enable_touch_optimizations** :ref:`🔗` -如果为 ``true``\ ，则增加滚动条触摸区域以提高触摸屏设备的可用性。 +如果为 ``true``\ ，则增加滚动条触摸区域，并为拆分容器启用更大的拖动器，从而提高在触摸屏设备上的可用性 \ **注意：**\ 在触摸屏设备上默认为 ``true``\ 。 @@ -4364,11 +4604,25 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- -.. _class_EditorSettings_property_network/connection/engine_version_update_mode: +.. _class_EditorSettings_property_interface/touchscreen/touch_actions_panel: .. rst-class:: classref-property -:ref:`int` **network/connection/engine_version_update_mode** :ref:`🔗` +:ref:`int` **interface/touchscreen/touch_actions_panel** :ref:`🔗` + +支持触摸的面板，无需键盘即可轻松访问保存、删除、撤消、重做等常见动作。 + +\ **注意：**\ 仅在 Android 和 XR 编辑器中可用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_network/connection/check_for_updates: + +.. rst-class:: classref-property + +:ref:`int` **network/connection/check_for_updates** :ref:`🔗` 指定引擎检查更新的方式。 @@ -4394,6 +4648,8 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 决定编辑器中是否启用资产库、更新检查等在线功能。禁用这些在线功能可以防止编辑器向 Godot 网站和托管资产库中资产的第三方平台发出 HTTP 请求，有助于减轻对隐私的担忧。 +建议编辑器插件和工具脚本遵循该设置。但是 Godot 无法阻止违反该规则的行为。 + .. rst-class:: classref-item-separator ---- @@ -4640,7 +4896,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 从编辑器启动项目时，用于显示项目的窗口模式。 -\ **注意：**\ “Force Maximized”和“Force Fullscreen”不支持游戏内嵌。 +\ **注意：**\ **Force Maximized**\ 和\ **Force Fullscreen**\ 不支持游戏内嵌。 .. rst-class:: classref-item-separator @@ -4730,6 +4986,18 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- +.. _class_EditorSettings_property_text_editor/appearance/enable_inline_color_picker: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/appearance/enable_inline_color_picker** :ref:`🔗` + +如果为 ``true``\ ，则脚本编辑器会在所有 :ref:`Color` 构造函数之前显示一个颜色按钮。点击按钮可以通过取色器修改该颜色。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/appearance/guidelines/line_length_guideline_hard_column: .. rst-class:: classref-property @@ -4940,7 +5208,11 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`bool` **text_editor/behavior/files/auto_reload_scripts_on_external_change** :ref:`🔗` -如果为 ``true``\ ，当脚本被外部编辑器修改和保存时，会自动在编辑器中重新加载脚本。 +如果为 ``true``\ ，则当脚本和基于文本的着色器被外部编辑器或工具修改并保存时，会在编辑器中自动重新加载，并且编辑器会重新获得焦点。在编辑器中加载外部更改后，可以使用“撤销”功能放弃外部更改。 + +如果为 ``false``\ ，则当编辑器重新获得焦点时，将始终显示文件冲突对话框。你可以使用该对话框选择是保留本地更改还是放弃。 + +\ **注意：**\ 即使该设置为 ``true``\ ，在某些情况下仍会显示文件冲突对话框。例如，当脚本编辑器有外部编辑器未考虑的未保存更改时就会显示。 .. rst-class:: classref-item-separator @@ -4970,6 +5242,20 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- +.. _class_EditorSettings_property_text_editor/behavior/files/drop_preload_resources_as_uid: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/files/drop_preload_resources_as_uid** :ref:`🔗` + +如果为 ``true``\ ，则将 :ref:`Resource` 文件拖放进脚本编辑器时按住 :kbd:`Ctrl`\ ，该资源就会使用 UID 进行预加载。如果为 ``false``\ ，该资源就会使用路径进行预加载。 + +按住 :kbd:`Ctrl+Shift` 时行为逆转。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/files/open_dominant_script_on_scene_change: .. rst-class:: classref-property @@ -5234,7 +5520,15 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`bool` **text_editor/completion/add_type_hints** :ref:`🔗` -如果为 ``true`` ，则在使用代码自动补全时，或在按下 :kbd:`Ctrl` 键的同时将节点拖放到脚本编辑器中创建 onready 变量时，将添加 :doc:`GDScript 静态类型 <../tutorials/scripting/gdscript/static_typing>` 提示，类型提示类似 ``-> void`` 和 ``: int`` 。如果为 ``true``\ ，则新创建的脚本也会自动将类型提示添加到其方法参数和返回类型中。 +如果为 ``true``\ ，则会在可能的情况下自动添加 :doc:`GDScript 静态类型 <../tutorials/scripting/gdscript/static_typing>`\ （例如 ``-> void`` 和 ``: int``\ ），包括： + +- 接受代码补全建议； + +- 根据模板新建脚本； + +- 在“节点”面板连接信号； + +- 按住 :kbd:`Ctrl` 将“场景”面板中的节点拖放进脚本编辑器中创建 :ref:`@GDScript.@onready` 变量。 .. rst-class:: classref-item-separator @@ -5682,6 +5976,84 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/critical_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/comment_markers/critical_color** :ref:`🔗` + +脚本编辑器中，关键注释标记文本的颜色。这些标记由 :ref:`text_editor/theme/highlighting/comment_markers/critical_list` 决定。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/critical_list: + +.. rst-class:: classref-property + +:ref:`String` **text_editor/theme/highlighting/comment_markers/critical_list** :ref:`🔗` + +注释中需要高亮的单词列表，区分大小写，用英文逗号分隔。脚本编辑器中会使用 :ref:`text_editor/theme/highlighting/comment_markers/critical_color` 颜色高亮显示这些文本。不能包含空格和符号，否则无法高亮。 + +\ **注意：**\ 仅在 GDScript 语法高亮器中实现。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/notice_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/comment_markers/notice_color** :ref:`🔗` + +脚本编辑器中，注意注释标记文本的颜色。这些标记由 :ref:`text_editor/theme/highlighting/comment_markers/notice_list` 决定。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/notice_list: + +.. rst-class:: classref-property + +:ref:`String` **text_editor/theme/highlighting/comment_markers/notice_list** :ref:`🔗` + +注释中需要高亮的单词列表，区分大小写，用英文逗号分隔。脚本编辑器中会使用 :ref:`text_editor/theme/highlighting/comment_markers/notice_color` 颜色高亮显示这些文本。不能包含空格和符号，否则无法高亮。 + +\ **注意：**\ 仅在 GDScript 语法高亮器中实现。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/warning_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/comment_markers/warning_color** :ref:`🔗` + +脚本编辑器中，警告注释标记文本的颜色。这些标记由 :ref:`text_editor/theme/highlighting/comment_markers/warning_list` 决定。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/comment_markers/warning_list: + +.. rst-class:: classref-property + +:ref:`String` **text_editor/theme/highlighting/comment_markers/warning_list** :ref:`🔗` + +注释中需要高亮的单词列表，区分大小写，用英文逗号分隔。脚本编辑器中会使用 :ref:`text_editor/theme/highlighting/comment_markers/warning_color` 颜色高亮显示这些文本。不能包含空格和符号，否则无法高亮。 + +\ **注意：**\ 仅在 GDScript 语法高亮器中实现。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/theme/highlighting/completion_background_color: .. rst-class:: classref-property @@ -5834,7 +6206,79 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 脚本编辑器中，函数调用的颜色。 -\ **注意：**\ 当使用 GDScript 语法高亮器时，这将被语法主题中为函数定义（例如：\ ``func _ready():`` ）配置的函数定义颜色所取代。 +\ **注意：**\ 当使用 GDScript 语法高亮器时，这仅在调用某些函数时使用，因为函数定义和全局函数有它们自己的颜色 :ref:`text_editor/theme/highlighting/gdscript/function_definition_color` 和 :ref:`text_editor/theme/highlighting/gdscript/global_function_color`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/annotation_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/annotation_color** :ref:`🔗` + +GDScript 语法高亮器对注解所使用的文本颜色（例如 ``@export``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/function_definition_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/function_definition_color** :ref:`🔗` + +GDScript 语法高亮器对函数定义所使用的文本颜色（例如 ``func _ready():`` 中的 ``_ready``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/global_function_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/global_function_color** :ref:`🔗` + +GDScript 语法高亮器对 :ref:`@GlobalScope` 等处列出的全局函数所使用的文本颜色（例如 ``preload()``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/node_path_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/node_path_color** :ref:`🔗` + +GDScript 语法高亮器对 :ref:`NodePath` 字面量所使用的文本颜色（例如 ``^"position:x"``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/node_reference_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/node_reference_color** :ref:`🔗` + +GDScript 语法高亮器对节点引用字面量所使用的文本颜色（例如 ``$"Sprite"`` 和 ``%"Sprite"``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/highlighting/gdscript/string_name_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/gdscript/string_name_color** :ref:`🔗` + +The GDScript syntax highlighter text color for :ref:`StringName` literals (e.g. ``&"example"``). .. rst-class:: classref-item-separator @@ -6006,7 +6450,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 :ref:`Color` **text_editor/theme/highlighting/text_selected_color** :ref:`🔗` -脚本编辑器中，文本的背景颜色。这应该被设置为半透明颜色，以便它可以显示在其他的行颜色修饰之上，例如 :ref:`text_editor/theme/highlighting/current_line_color`\ 。 +脚本编辑器中，文本的背景色。应设置为半透明颜色，从而将其显示在其他的行颜色修饰之上，例如 :ref:`text_editor/theme/highlighting/current_line_color`\ 。 .. rst-class:: classref-item-separator @@ -6024,6 +6468,18 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- +.. _class_EditorSettings_property_text_editor/theme/highlighting/warning_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/warning_color** :ref:`🔗` + +脚本编辑器中，有警告的行的背景色。应设置为半透明颜色，从而将其显示在其他的行颜色修饰之上，例如 :ref:`text_editor/theme/highlighting/current_line_color`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/theme/highlighting/word_highlighted_color: .. rst-class:: classref-property @@ -6036,18 +6492,6 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 ---- -.. _class_EditorSettings_property_text_editor/theme/line_spacing: - -.. rst-class:: classref-property - -:ref:`int` **text_editor/theme/line_spacing** :ref:`🔗` - -文本编辑器中使用的纵向行间距，单位为像素。 - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorSettings_property_version_control/ssh_private_key_path: .. rst-class:: classref-property @@ -6110,29 +6554,29 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 var settings = EditorInterface.get_editor_settings() settings.set("category/property_name", 0) - + var property_info = { "name": "category/property_name", "type": TYPE_INT, "hint": PROPERTY_HINT_ENUM, "hint_string": "one,two,three" } - + settings.add_property_info(property_info) .. code-tab:: csharp var settings = GetEditorInterface().GetEditorSettings(); settings.Set("category/property_name", 0); - + var propertyInfo = new Godot.Collections.Dictionary { - {"name", "category/propertyName"}, - {"type", Variant.Type.Int}, - {"hint", PropertyHint.Enum}, - {"hint_string", "one,two,three"} + { "name", "category/propertyName" }, + { "type", Variant.Type.Int }, + { "hint", PropertyHint.Enum }, + { "hint_string", "one,two,three" }, }; - + settings.AddPropertyInfo(propertyInfo); @@ -6318,6 +6762,7 @@ FreeType 的字体抗锯齿模式，用于渲染编辑器字体。大多数字 将由 ``name`` 指定的设置项设置为 ``value``\ 。等价于在 EditorSettings 实例上使用 :ref:`Object.set()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorspinslider.rst b/classes/zh_CN/class_editorspinslider.rst index 011c94ccad..fa6534f141 100644 --- a/classes/zh_CN/class_editorspinslider.rst +++ b/classes/zh_CN/class_editorspinslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorSpinSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSpinSlider.xml. .. _class_EditorSpinSlider: @@ -267,6 +267,7 @@ Godot 编辑器用于编辑数值的控件。 控件只读或禁用时，代表上下按钮的单张纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorsyntaxhighlighter.rst b/classes/zh_CN/class_editorsyntaxhighlighter.rst index 1f7d373f23..da5f9de713 100644 --- a/classes/zh_CN/class_editorsyntaxhighlighter.rst +++ b/classes/zh_CN/class_editorsyntaxhighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorSyntaxHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSyntaxHighlighter.xml. .. _class_EditorSyntaxHighlighter: @@ -33,11 +33,13 @@ EditorSyntaxHighlighter .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_supported_languages`\ (\ ) |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorSyntaxHighlighter` | :ref:`_create`\ (\ ) |virtual| |const| | + +---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_supported_languages`\ (\ ) |virtual| |const| | + +---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -48,6 +50,18 @@ EditorSyntaxHighlighter 方法说明 -------- +.. _class_EditorSyntaxHighlighter_private_method__create: + +.. rst-class:: classref-method + +:ref:`EditorSyntaxHighlighter` **_create**\ (\ ) |virtual| |const| :ref:`🔗` + +虚函数，可以创建一个语法高亮器新实例。 + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSyntaxHighlighter_private_method__get_name: .. rst-class:: classref-method @@ -69,6 +83,7 @@ EditorSyntaxHighlighter 虚函数，可以在重写后返回所支持的语言名称。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editortoaster.rst b/classes/zh_CN/class_editortoaster.rst index 991a404eba..cc75a3a093 100644 --- a/classes/zh_CN/class_editortoaster.rst +++ b/classes/zh_CN/class_editortoaster.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorToaster.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorToaster.xml. .. _class_EditorToaster: @@ -92,6 +92,7 @@ enum **Severity**: :ref:`🔗` 将需要显示的 Toast 通知推送给编辑器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editortranslationparserplugin.rst b/classes/zh_CN/class_editortranslationparserplugin.rst index 84e039c277..52fa2d3d17 100644 --- a/classes/zh_CN/class_editortranslationparserplugin.rst +++ b/classes/zh_CN/class_editortranslationparserplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorTranslationParserPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorTranslationParserPlugin.xml. .. _class_EditorTranslationParserPlugin: @@ -34,7 +34,7 @@ EditorTranslationParserPlugin @tool extends EditorTranslationParserPlugin - + func _parse_file(path): var ret: Array[PackedStringArray] = [] var file = FileAccess.open(path, FileAccess.READ) @@ -43,16 +43,16 @@ EditorTranslationParserPlugin for s in split_strs: ret.append(PackedStringArray([s])) #print("提取到字符串：" + s) - + return ret - + func _get_recognized_extensions(): return ["csv"] .. code-tab:: csharp using Godot; - + [Tool] public partial class CustomParser : EditorTranslationParserPlugin { @@ -69,7 +69,7 @@ EditorTranslationParserPlugin } return ret; } - + public override string[] _GetRecognizedExtensions() { return ["csv"]; @@ -114,7 +114,7 @@ EditorTranslationParserPlugin var res = ResourceLoader.load(path, "Script") var text = res.source_code # 解析逻辑。 - + func _get_recognized_extensions(): return ["gd"] @@ -126,7 +126,7 @@ EditorTranslationParserPlugin string text = res.SourceCode; // 解析逻辑。 } - + public override string[] _GetRecognizedExtensions() { return ["gd"]; @@ -180,6 +180,7 @@ EditorTranslationParserPlugin 覆盖该方法，定义自定义解析逻辑以提取可翻译的字符串。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorundoredomanager.rst b/classes/zh_CN/class_editorundoredomanager.rst index c263aaf798..a37b9aff53 100644 --- a/classes/zh_CN/class_editorundoredomanager.rst +++ b/classes/zh_CN/class_editorundoredomanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorUndoRedoManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorUndoRedoManager.xml. .. _class_EditorUndoRedoManager: @@ -43,33 +43,33 @@ EditorUndoRedoManager .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_do_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_do_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_do_reference`\ (\ object\: :ref:`Object`\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_undo_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_undo_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_undo_reference`\ (\ object\: :ref:`Object`\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_history`\ (\ id\: :ref:`int` = -99, increase_version\: :ref:`bool` = true\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`commit_action`\ (\ execute\: :ref:`bool` = true\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`create_action`\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`force_fixed_history`\ (\ ) | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UndoRedo` | :ref:`get_history_undo_redo`\ (\ id\: :ref:`int`\ ) |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_object_history_id`\ (\ object\: :ref:`Object`\ ) |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_committing_action`\ (\ ) |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_reference`\ (\ object\: :ref:`Object`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_reference`\ (\ object\: :ref:`Object`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_history`\ (\ id\: :ref:`int` = -99, increase_version\: :ref:`bool` = true\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`commit_action`\ (\ execute\: :ref:`bool` = true\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_action`\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false, mark_unsaved\: :ref:`bool` = true\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_fixed_history`\ (\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UndoRedo` | :ref:`get_history_undo_redo`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_object_history_id`\ (\ object\: :ref:`Object`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_committing_action`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -266,16 +266,18 @@ enum **SpecialHistory**: :ref:`🔗` .. rst-class:: classref-method -|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) :ref:`🔗` +|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false, mark_unsaved\: :ref:`bool` = true\ ) :ref:`🔗` 创建一个新的动作。调用后，请执行所有你需要的 :ref:`add_do_method()`\ 、\ :ref:`add_undo_method()`\ 、\ :ref:`add_do_property()` 和 :ref:`add_undo_property()` 调用，然后再用 :ref:`commit_action()` 提交这个动作。 -动作的合并方式由 ``merge_mode`` 参数决定。详见 :ref:`MergeMode`\ 。 +动作的合并方式由 ``merge_mode`` 参数决定。 如果提供了 ``custom_context`` 对象，则它将被用于推断目标历史（而不是使用第一个操作）。 动作中撤销操作的顺序由 ``backward_undo_ops`` 决定。\ ``backward_undo_ops`` 为 ``false`` 时，撤销选项的顺序和添加顺序一致。也就是说，先添加的操作会先撤销。 +如果 ``mark_unsaved`` 为 ``false``\ ，则该动作不会将历史标记为未保存。例如，适用于修改选中项的动作，或自动保存的设置项。否则，如果动作需要用户进行保存或不保存可能导致数据丢失，请将其保持为 ``true``\ 。 + .. rst-class:: classref-item-separator ---- @@ -331,6 +333,7 @@ enum **SpecialHistory**: :ref:`🔗` 如果 **EditorUndoRedoManager** 当前正在提交该动作，即运行其“做”方法或属性更改（请参阅 :ref:`commit_action()`\ ）时，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_editorvcsinterface.rst b/classes/zh_CN/class_editorvcsinterface.rst index 9884cebc51..2a988386c7 100644 --- a/classes/zh_CN/class_editorvcsinterface.rst +++ b/classes/zh_CN/class_editorvcsinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EditorVCSInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorVCSInterface.xml. .. _class_EditorVCSInterface: @@ -36,69 +36,69 @@ EditorVCSInterface .. table:: :widths: auto - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_checkout_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_commit`\ (\ msg\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_create_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_create_remote`\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_discard_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_fetch`\ (\ remote\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`String`\] | :ref:`_get_branch_list`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_current_branch_name`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_diff`\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_line_diff`\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_modified_files_data`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_previous_commits`\ (\ max_commits\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`String`\] | :ref:`_get_remotes`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_vcs_name`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_initialize`\ (\ project_path\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pull`\ (\ remote\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_push`\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_remove_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_remove_remote`\ (\ remote_name\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_credentials`\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shut_down`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_stage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_unstage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file`\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk`\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_commit`\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_file`\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_hunk`\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_line`\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_status_file`\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`popup_error`\ (\ msg\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_checkout_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit`\ (\ msg\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_create_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_create_remote`\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_discard_file`\ (\ file_path\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_fetch`\ (\ remote\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`_get_branch_list`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_current_branch_name`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_diff`\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_line_diff`\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_modified_files_data`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_previous_commits`\ (\ max_commits\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`_get_remotes`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_vcs_name`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_initialize`\ (\ project_path\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pull`\ (\ remote\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_push`\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_remote`\ (\ remote_name\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_credentials`\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shut_down`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_unstage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file`\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk`\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_commit`\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_file`\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_hunk`\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_line`\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_status_file`\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_error`\ (\ msg\: :ref:`String`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -210,7 +210,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`bool` **_checkout_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`bool` **_checkout_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 检出 VCS 中的 ``branch_name`` 分支。 @@ -222,7 +222,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_commit**\ (\ msg\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_commit**\ (\ msg\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 提交当前暂存的修改，并对提交应用提交信息 ``msg``\ 。 @@ -234,7 +234,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_create_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_create_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 在 VCS 中新建名为 ``branch_name`` 的分支。 @@ -246,7 +246,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_create_remote**\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_create_remote**\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 创建一个名为 ``remote_name`` 的新远程仓库目标，并将其指向 ``remote_url``\ 。这既可以是 HTTPS 远程仓库，也可以是 SSH 远程仓库。 @@ -258,7 +258,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_discard_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_discard_file**\ (\ file_path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 丢弃对位于 ``file_path`` 的文件进行的修改。 @@ -270,7 +270,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_fetch**\ (\ remote\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_fetch**\ (\ remote\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 从远程仓库 ``remote`` 中抓取新修改，但不将修改写入当前工作目录。相当于 ``git fetch``\ 。 @@ -282,7 +282,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **_get_branch_list**\ (\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`String`\] **_get_branch_list**\ (\ ) |virtual| |required| :ref:`🔗` 获取 :ref:`String` 字符串的 :ref:`Array` 数组实例，包含在 VCS 中可用的分支名称。 @@ -294,7 +294,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`String` **_get_current_branch_name**\ (\ ) |virtual| :ref:`🔗` +:ref:`String` **_get_current_branch_name**\ (\ ) |virtual| |required| :ref:`🔗` 获取 VCS 中定义的当前分支名称。 @@ -306,7 +306,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_diff**\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_diff**\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 返回 :ref:`Dictionary` 项的数组（参见 :ref:`create_diff_file()`\ 、\ :ref:`create_diff_hunk()`\ 、\ :ref:`create_diff_line()`\ 、\ :ref:`add_line_diffs_into_diff_hunk()` 和 :ref:`add_diff_hunks_into_diff_file()`\ ），每项都包含一个差异的信息。如果 ``identifier`` 是文件路径，则返回文件差异；如果它是提交标识符，则返回提交差异。 @@ -318,7 +318,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_line_diff**\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_line_diff**\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 返回 :ref:`Dictionary` 字典项的 :ref:`Array` 数组（见 :ref:`create_diff_hunk()`\ ），每一项都包含位于 ``file_path`` 的文件与传入的 ``text`` 之间的单行差异。 @@ -330,7 +330,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_modified_files_data**\ (\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_modified_files_data**\ (\ ) |virtual| |required| :ref:`🔗` 返回 :ref:`Dictionary` 字典项的 :ref:`Array` 数组（见 :ref:`create_status_file()`\ ），每一项都包含项目文件夹中每个已修改的文件的状态数据。 @@ -342,7 +342,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 返回 :ref:`Dictionary` 字典项的 :ref:`Array` 数组（见 :ref:`create_commit()`\ ），每一项都包含一个过去提交的数据。 @@ -354,7 +354,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **_get_remotes**\ (\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`String`\] **_get_remotes**\ (\ ) |virtual| |required| :ref:`🔗` 返回 :ref:`String` 字符串的 :ref:`Array` 数组，每一个都包含 VCS 中配置的一个远程仓库的名称。 @@ -366,7 +366,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`String` **_get_vcs_name**\ (\ ) |virtual| :ref:`🔗` +:ref:`String` **_get_vcs_name**\ (\ ) |virtual| |required| :ref:`🔗` 返回底层 VCS 提供方的名称。 @@ -378,7 +378,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`bool` **_initialize**\ (\ project_path\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`bool` **_initialize**\ (\ project_path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 从编辑器中调用时初始化该 VCS 插件。返回该插件是否成功初始化。会在 ``project_path`` 初始化 VCS 项目。 @@ -390,7 +390,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_pull**\ (\ remote\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_pull**\ (\ remote\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 从远程仓库拉取修改。这可能会导致合并冲突。 @@ -402,7 +402,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_push**\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_push**\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 将修改推送至远程仓库 ``remote``\ 。如果 ``force`` 为 ``true``\ ，则会进行强制推送，覆盖远程仓库中现有的修改历史。 @@ -414,7 +414,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_remove_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_remove_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 从本地 VCS 中移除一个分支。 @@ -426,7 +426,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_remove_remote**\ (\ remote_name\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_remove_remote**\ (\ remote_name\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 从本地 VCS 中移除一个远程仓库。 @@ -438,7 +438,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_set_credentials**\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_set_credentials**\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 在底层 VCS 中设置用户认证信息。用户名 ``username`` 和密码 ``password`` 只会在进行 HTTPS 认证且没有在远程仓库 URL 中给出时使用。SSH 公钥路径 ``ssh_public_key_path``\ 、SSH 私钥路径 ``ssh_private_key_path``\ 、SSH 密码 ``ssh_passphrase`` 只会在进行 SSH 认证时使用。 @@ -450,7 +450,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -:ref:`bool` **_shut_down**\ (\ ) |virtual| :ref:`🔗` +:ref:`bool` **_shut_down**\ (\ ) |virtual| |required| :ref:`🔗` 关闭 VCS 插件实例。会在用户关闭编辑器或通过编辑器 UI 关闭该 VCS 插件时调用。 @@ -462,7 +462,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_stage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_stage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 将位于 ``file_path`` 的文件暂存到暂存区。 @@ -474,7 +474,7 @@ enum **TreeArea**: :ref:`🔗` .. rst-class:: classref-method -|void| **_unstage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_unstage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 将位于 ``file_path`` 的文件从暂存区撤销到未暂存区。 @@ -575,6 +575,7 @@ enum **TreeArea**: :ref:`🔗` 在编辑器中弹出一条错误消息，显示为来自底层 VCS。使用它来显示 VCS 特定的错误消息。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_encodedobjectasid.rst b/classes/zh_CN/class_encodedobjectasid.rst index 159bf0268a..e57e67cc7d 100644 --- a/classes/zh_CN/class_encodedobjectasid.rst +++ b/classes/zh_CN/class_encodedobjectasid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EncodedObjectAsID.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EncodedObjectAsID.xml. .. _class_EncodedObjectAsID: @@ -58,6 +58,7 @@ EncodedObjectAsID 存储在该 **EncodedObjectAsID** 实例中的 :ref:`Object` 标识符。可以使用 :ref:`@GlobalScope.instance_from_id()` 检索对象实例。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_enetconnection.rst b/classes/zh_CN/class_enetconnection.rst index 1cb9538ce1..343a40505d 100644 --- a/classes/zh_CN/class_enetconnection.rst +++ b/classes/zh_CN/class_enetconnection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/enet/doc_classes/ENetConnection.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetConnection.xml. .. _class_ENetConnection: @@ -418,7 +418,7 @@ enum **HostStatistic**: :ref:`🔗` :ref:`float` **pop_statistic**\ (\ statistic\: :ref:`HostStatistic`\ ) :ref:`🔗` -返回并重置主机统计信息。详见 :ref:`HostStatistic`\ 。 +返回并重置主机统计信息。 .. rst-class:: classref-item-separator @@ -467,6 +467,7 @@ enum **HostStatistic**: :ref:`🔗` 要求在 NAT 设备处理连接请求后，预先了解公共互联网所看到的潜在客户端的地址和通信端口。这一信息可以通过 `STUN `__ 服务获取，必须由非潜在客户端的实体交给你的主机。由于对称 NAT 路由算法的性质，这种方法对于对称 NAT 之后的客户端无效，因为无法提前得知他们的 IP 和端口。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_enetmultiplayerpeer.rst b/classes/zh_CN/class_enetmultiplayerpeer.rst index 5882bf292d..5b4d871906 100644 --- a/classes/zh_CN/class_enetmultiplayerpeer.rst +++ b/classes/zh_CN/class_enetmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/enet/doc_classes/ENetMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetMultiplayerPeer.xml. .. _class_ENetMultiplayerPeer: @@ -167,6 +167,7 @@ MultiplayerPeer 的一种实现，应该在初始化为客户端、服务器或 创建服务器时使用的 IP。默认情况下，这被设置为通配符 ``"*"``\ ，它绑定到所有可用的接口。给定的 IP 地址格式需要是 IPv4 或 IPv6，例如：\ ``"192.168.1.1"``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_enetpacketpeer.rst b/classes/zh_CN/class_enetpacketpeer.rst index 5708a531a7..9c7e837c8c 100644 --- a/classes/zh_CN/class_enetpacketpeer.rst +++ b/classes/zh_CN/class_enetpacketpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/enet/doc_classes/ENetPacketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetPacketPeer.xml. .. _class_ENetPacketPeer: @@ -143,7 +143,7 @@ enum **PeerState**: :ref:`🔗` :ref:`PeerState` **STATE_DISCONNECT_LATER** = ``6`` -该对等体在没有更多的外发数据包可以发送后，将被预定断开连接。 +该对等体在没有更多的外发数据包可以发送后，将预计断开连接。 .. _class_ENetPacketPeer_constant_STATE_DISCONNECTING: @@ -403,7 +403,7 @@ enum **PeerStatistic**: :ref:`🔗` :ref:`PeerState` **get_state**\ (\ ) |const| :ref:`🔗` -返回该对等体的当前状态。见 :ref:`PeerState`\ 。 +返回当前的对等体状态。 .. rst-class:: classref-item-separator @@ -415,7 +415,7 @@ enum **PeerStatistic**: :ref:`🔗` :ref:`float` **get_statistic**\ (\ statistic\: :ref:`PeerStatistic`\ ) :ref:`🔗` -返回此对等体请求的 ``statistic``\ 。见 :ref:`PeerStatistic`\ 。 +返回该对等体的统计信息，由 ``statistic`` 指定。 .. rst-class:: classref-item-separator @@ -548,6 +548,7 @@ enum **PeerStatistic**: :ref:`🔗` 节流的中间值表示发送不可靠数据包的 0% 到 100% 之间的中间概率。考虑本地和外部主机的带宽限制，以确定节流概率的合理限制，即使在最好的条件下也不应超过该限制。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_engine.rst b/classes/zh_CN/class_engine.rst index 9cabebf461..2eae9a9c95 100644 --- a/classes/zh_CN/class_engine.rst +++ b/classes/zh_CN/class_engine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Engine.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Engine.xml. .. _class_Engine: @@ -53,59 +53,61 @@ Engine .. table:: :widths: auto - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_architecture_name`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_author_info`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_copyright_info`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_donor_info`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frames_drawn`\ (\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_frames_per_second`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_license_info`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_license_text`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MainLoop` | :ref:`get_main_loop`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_physics_frames`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_physics_interpolation_fraction`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_frames`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptLanguage` | :ref:`get_script_language`\ (\ index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_script_language_count`\ (\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_singleton_list`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_version_info`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_write_movie_path`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editor_hint`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_embedded_in_editor`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_physics_frame`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`register_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_singleton`\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`unregister_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_singleton`\ (\ name\: :ref:`StringName`\ ) | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`ScriptBacktrace`\] | :ref:`capture_script_backtraces`\ (\ include_variables\: :ref:`bool` = false\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_architecture_name`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_author_info`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_copyright_info`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_donor_info`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frames_drawn`\ (\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_frames_per_second`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_license_info`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_license_text`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MainLoop` | :ref:`get_main_loop`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_physics_frames`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_physics_interpolation_fraction`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_frames`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptLanguage` | :ref:`get_script_language`\ (\ index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_script_language_count`\ (\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_singleton_list`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_version_info`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_write_movie_path`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editor_hint`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_embedded_in_editor`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_physics_frame`\ (\ ) |const| | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`register_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_singleton`\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`unregister_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_singleton`\ (\ name\: :ref:`StringName`\ ) | + +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -274,13 +276,31 @@ Engine 方法说明 -------- +.. _class_Engine_method_capture_script_backtraces: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`ScriptBacktrace`\] **capture_script_backtraces**\ (\ include_variables\: :ref:`bool` = false\ ) |const| :ref:`🔗` + +捕获并返回所有注册脚本语言的追踪信息。 + +默认情况下，返回的 :ref:`ScriptBacktrace` 仅在编辑器构建和调试构建中包含栈帧。要在发布构建中也启用，就需要启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks`\ 。 + +如果 ``include_variables`` 为 ``true``\ ，则追踪信息中还包括捕获时的所有全局变量（例如自动加载的单例）的名称和值，以及各个栈帧中的局部变量和类成员变量。不过这个参数只有在运行游戏时附加了调试器的情况下才会生效，例如从编辑器运行游戏。要在导出构建中也启用此功能，就需要启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_local_variables`\ 。 + +\ **警告：**\ 当 ``include_variables`` 为 ``true`` 时，捕获的变量可能是变量中的实际值（例如 GDScript 的追踪信息），包含对象引用。这意味着存储这样的 :ref:`ScriptBacktrace` 会阻止这些对象的释放，因此通常不建议这么做。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Engine_method_get_architecture_name: .. rst-class:: classref-method :ref:`String` **get_architecture_name**\ (\ ) |const| :ref:`🔗` -返回构建 Godot 二进制文件所针对的 CPU 架构的名称。可能的返回值有 ``"x86_64"``\ 、\ ``"x86_32"``\ 、\ ``"arm64"``\ 、\ ``"arm32"``\ 、\ ``"rv64"``\ 、\ ``"riscv"``\ 、\ ``"ppc64"``\ 、\ ``"ppc"``\ 、\ ``"wasm64"`` 和 ``"wasm32"``\ 。 +返回构建 Godot 二进制文件所针对的 CPU 架构的名称。可能的返回值有 ``"x86_64"``\ 、\ ``"x86_32"``\ 、\ ``"arm64"``\ 、\ ``"arm32"``\ 、\ ``"rv64"``\ 、\ ``"ppc64"``\ 、\ ``"loongarch64"``\ 、\ ``"wasm64"`` 和 ``"wasm32"``\ 。 检测当前构建是否为 64 位或检测架构类型时请勿使用架构名称进行判断。请使用 :ref:`OS.has_feature()`\ ，检测 ``"64"`` 特性标签，或者 ``"x86"``\ 、\ ``"arm"`` 等标签。详见\ :doc:`《特性标签》 <../tutorials/export/feature_tags>`\ 文档。 @@ -424,7 +444,7 @@ Engine public override void _PhysicsProcess(double delta) { base._PhysicsProcess(delta); - + if (Engine.GetPhysicsFrames() % 2 == 0) { // 此处每 2 个物理帧仅运行一次昂贵的逻辑。 @@ -473,7 +493,7 @@ Engine public override void _Process(double delta) { base._Process(delta); - + if (Engine.GetProcessFrames() % 2 == 0) { // 此处每 2 个处理（渲染）帧仅运行一次昂贵的逻辑。 @@ -699,10 +719,10 @@ Engine # 根据节点添加到树中的时间， # 输出 “true” 或 “false”。 print(Engine.is_in_physics_frame()) - + func _process(delta): print(Engine.is_in_physics_frame()) # 输出 false - + func _physics_process(delta): print(Engine.is_in_physics_frame()) # 输出 true @@ -769,6 +789,7 @@ Engine 移除在 ``name`` 下注册的单例。该单例对象\ *不会*\ 被释放。仅适用于使用 :ref:`register_singleton()` 注册的用户定义的单例。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_enginedebugger.rst b/classes/zh_CN/class_enginedebugger.rst index 7dfa6eba13..5cbcd52f6b 100644 --- a/classes/zh_CN/class_enginedebugger.rst +++ b/classes/zh_CN/class_enginedebugger.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EngineDebugger.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EngineDebugger.xml. .. _class_EngineDebugger: @@ -371,6 +371,7 @@ EngineDebugger 将具有给定名称 ``name`` 的分析器解除注册。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_engineprofiler.rst b/classes/zh_CN/class_engineprofiler.rst index 0ce1602d67..5564a89b56 100644 --- a/classes/zh_CN/class_engineprofiler.rst +++ b/classes/zh_CN/class_engineprofiler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/EngineProfiler.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EngineProfiler.xml. .. _class_EngineProfiler: @@ -81,6 +81,7 @@ EngineProfiler 启用/禁用分析器时调用，提供了一组选项 ``options``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_environment.rst b/classes/zh_CN/class_environment.rst index bfcf9948f2..d323024f8a 100644 --- a/classes/zh_CN/class_environment.rst +++ b/classes/zh_CN/class_environment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Environment.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Environment.xml. .. _class_Environment: @@ -835,7 +835,7 @@ enum **SDFGIYScale**: :ref:`🔗` - |void| **set_background**\ (\ value\: :ref:`BGMode`\ ) - :ref:`BGMode` **get_background**\ (\ ) -背景模式。可能的取值见 :ref:`BGMode`\ 。 +背景的模式。 .. rst-class:: classref-item-separator @@ -1030,7 +1030,7 @@ enum **SDFGIYScale**: :ref:`🔗` - |void| **set_fog_mode**\ (\ value\: :ref:`FogMode`\ ) - :ref:`FogMode` **get_fog_mode**\ (\ ) -雾模式。可能的取值见 :ref:`FogMode`\ 。 +雾的模式。 .. rst-class:: classref-item-separator @@ -2360,6 +2360,7 @@ SDFGI 可见的最大距离。超出该距离，环境照明或其他 GI 来源 设置辉光级别 ``idx`` 的强度。大于 ``0.0`` 时启用该级别。每个级别都依赖于前一个级别。这意味着启用较高的辉光等级会减慢辉光效果的渲染速度，即使之前的等级没有启用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_expression.rst b/classes/zh_CN/class_expression.rst index 506b561bff..ff929830a6 100644 --- a/classes/zh_CN/class_expression.rst +++ b/classes/zh_CN/class_expression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Expression.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Expression.xml. .. _class_Expression: @@ -31,10 +31,10 @@ Expression .. code-tab:: gdscript var expression = Expression.new() - + func _ready(): $LineEdit.text_submitted.connect(self._on_text_submitted) - + func _on_text_submitted(command): var error = expression.parse(command) if error != OK: @@ -47,12 +47,12 @@ Expression .. code-tab:: csharp private Expression _expression = new Expression(); - + public override void _Ready() { GetNode("LineEdit").TextSubmitted += OnTextEntered; } - + private void OnTextEntered(string command) { Error error = _expression.Parse(command); @@ -153,6 +153,7 @@ Expression 你也可以选择用 ``input_names`` 来指定可能出现在表达式中的变量名称，这样就可以在执行表达式时进行绑定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_externaltexture.rst b/classes/zh_CN/class_externaltexture.rst index f5dd0e73e7..cdcea09438 100644 --- a/classes/zh_CN/class_externaltexture.rst +++ b/classes/zh_CN/class_externaltexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ExternalTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ExternalTexture.xml. .. _class_ExternalTexture: @@ -109,6 +109,7 @@ ExternalTexture 根据你的需求，你可能需要使用从平台 API 获取的数据调用该方法，例如在 Android 上的 ``SurfaceTexture.getHardwareBuffer()``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_fastnoiselite.rst b/classes/zh_CN/class_fastnoiselite.rst index 3cb2c81bfb..b14c88d7e7 100644 --- a/classes/zh_CN/class_fastnoiselite.rst +++ b/classes/zh_CN/class_fastnoiselite.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/noise/doc_classes/FastNoiseLite.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/FastNoiseLite.xml. .. _class_FastNoiseLite: @@ -104,9 +104,9 @@ enum **NoiseType**: :ref:`🔗` :ref:`NoiseType` **TYPE_VALUE_CUBIC** = ``4`` -类似于 Value 噪声，但速度较慢。波峰和波谷的变化更大。 +类似于 Value 噪声（\ :ref:`TYPE_VALUE`\ ），但速度较慢。波峰和波谷的变化更大。 -在使用值噪声创建凹凸贴图时，可以使用三次噪声来避免某些伪影。一般来说，如果值噪声用于高度图或凹凸贴图，则应始终使用此模式。 +在使用 Value 噪声创建凹凸贴图时，可以使用三次噪声来避免某些伪影。一般来说，如果 Value 噪声用于高度图或凹凸贴图，则应始终使用此模式。 .. _class_FastNoiseLite_constant_TYPE_PERLIN: @@ -378,7 +378,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`CellularDistanceFunction` **get_cellular_distance_function**\ (\ ) -确定如何计算到最近/第二最近点的距离。有关选项，请参阅 :ref:`CellularDistanceFunction`\ 。 +确定如何计算到最近/第二最近点的距离。 .. rst-class:: classref-item-separator @@ -412,7 +412,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`CellularReturnType` **get_cellular_return_type**\ (\ ) -蜂窝噪声计算的返回类型。请参阅 :ref:`CellularReturnType`\ 。 +蜂窝噪声计算的返回类型。 .. rst-class:: classref-item-separator @@ -482,7 +482,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`float` **get_domain_warp_fractal_lacunarity**\ (\ ) -扭曲空间的分形噪声的八度音阶空隙。增加此值，会导致更高的八度音阶，从而产生细节更精细、外观更粗糙的噪声。 +扭曲空间的分形噪声的八度音节之间的频率变化，也称为“间隙度”。增加此值，会导致更高的八度音阶，从而产生细节更精细、外观更粗糙的噪声。 .. rst-class:: classref-item-separator @@ -516,7 +516,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`DomainWarpFractalType` **get_domain_warp_fractal_type**\ (\ ) -将八度音阶组合成用于扭曲空间的分形的方法。请参阅 :ref:`DomainWarpFractalType`\ 。 +将八度音阶组合成用于扭曲空间的分形的方法。 .. rst-class:: classref-item-separator @@ -550,7 +550,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`DomainWarpType` **get_domain_warp_type**\ (\ ) -设置扭曲算法。请参阅 :ref:`DomainWarpType`\ 。 +扭曲算法。 .. rst-class:: classref-item-separator @@ -637,7 +637,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`FractalType` **get_fractal_type**\ (\ ) -将八度音阶组合成分形的方法。请参阅 :ref:`FractalType`\ 。 +将八度音阶组合成分形的方法。 .. rst-class:: classref-item-separator @@ -688,7 +688,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ ) - :ref:`NoiseType` **get_noise_type**\ (\ ) -所使用的噪声算法。见 :ref:`NoiseType`\ 。 +所使用的噪声算法。 .. rst-class:: classref-item-separator @@ -725,6 +725,7 @@ enum **DomainWarpFractalType**: :ref:`🔗`\ 文档中提到的用户数据文件夹中会存储一个名叫 ``"save_game.dat"`` 的文件： .. tabs:: @@ -31,7 +31,7 @@ FileAccess func save_to_file(content): var file = FileAccess.open("user://save_game.dat", FileAccess.WRITE) file.store_string(content) - + func load_from_file(): var file = FileAccess.open("user://save_game.dat", FileAccess.READ) var content = file.get_as_text() @@ -44,7 +44,7 @@ FileAccess using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Write); file.StoreString(content); } - + public string LoadFromFile() { using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Read); @@ -54,13 +54,13 @@ FileAccess -在上面的例子中，文件将被保存在\ :doc:`数据路径 <../tutorials/io/data_paths>`\ 文件中指定的用户数据文件夹中。 +\ **FileAccess** 实例拥有自己的文件游标，它是文件中下一次读/写操作将发生的位置（单位为字节）。诸如 :ref:`get_8()`\ 、\ :ref:`get_16()`\ 、\ :ref:`store_8()` 和 :ref:`store_16()` 等函数会将文件游标向前移动读/写的字节数。可以使用 :ref:`seek()` 或 :ref:`seek_end()` 将文件游标移动到特定位置，且可以使用 :ref:`get_position()` 获取其位置。 -\ **FileAccess** 会在释放时关闭，超出作用域、赋值为 ``null`` 等情况都会导致释放。可以使用 :ref:`close()` 在此之前显式关闭。在 C# 中，引用必须手动释放，可以通过 ``using`` 语句或直接调用 ``Dispose`` 方法来完成。 +\ **FileAccess** 实例被释放时会关闭对应的文件。由于这个类继承自 :ref:`RefCounted`\ ，不再使用实例时会自动触发该行为。可以使用 :ref:`close()` 在此之前显式关闭。在 C# 中引用必须手动释放，可以通过 ``using`` 语句或直接调用 ``Dispose`` 方法来完成。 \ **注意：**\ 要在导出后访问项目资源，建议使用 :ref:`ResourceLoader` 而不是 **FileAccess**\ ，因为有些文件已被转换为特定于引擎的格式，并且它们的原始源文件可能并不存在于导出的 PCK 包中。如果使用 **FileAccess**\ ，请确保通过在导入面板中将其导入模式更改为\ **保留文件（按原样导出）**\ 来将文件包含在导出中；或者对于没有此选项的文件，请在导出对话框中更改非资源导出筛选器，加上文件的扩展名（例如 ``*.txt``\ ）。 -\ **注意：**\ 只有当进程“正常”退出时（例如通过单击窗口管理器的关闭按钮或按 **Alt + F4**\ ），文件才会自动关闭。如果在项目运行时按 **F8** 停止项目执行，则不会关闭文件，因为游戏进程将被中止。可以通过定期调用 :ref:`flush()` 来解决这个问题。 +\ **注意：**\ 只有当进程“正常”退出时（例如通过单击窗口管理器的关闭按钮或按 :kbd:`Alt + F4`\ ），文件才会自动关闭。如果在项目运行时按 :kbd:`F8` 停止项目执行，则不会关闭文件，因为游戏进程将被中止。可以通过定期调用 :ref:`flush()` 来解决这个问题。 .. rst-class:: classref-introduction-group @@ -71,6 +71,8 @@ FileAccess - :doc:`运行时文件加载与保存 <../tutorials/io/runtime_file_loading_and_saving>` +- :doc:`二进制序列化 API <../tutorials/io/binary_serialization_api>` + - `3D 体素演示 `__ .. rst-class:: classref-reftable-group @@ -112,6 +114,8 @@ FileAccess +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_64`\ (\ ) |const| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_access_time`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_as_text`\ (\ skip_cr\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`get_buffer`\ (\ length\: :ref:`int`\ ) |const| | @@ -156,6 +160,8 @@ FileAccess +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_sha256`\ (\ path\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_size`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |bitfield|\[:ref:`UnixPermissionFlags`\] | :ref:`get_unix_permissions`\ (\ file\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_var`\ (\ allow_objects\: :ref:`bool` = false\ ) |const| | @@ -232,7 +238,7 @@ enum **ModeFlags**: :ref:`🔗` :ref:`ModeFlags` **READ** = ``1`` -打开文件进行读取操作。光标位于文件的开头。 +打开文件进行读取操作。文件游标位于文件的开头。 .. _class_FileAccess_constant_WRITE: @@ -240,7 +246,7 @@ enum **ModeFlags**: :ref:`🔗` :ref:`ModeFlags` **WRITE** = ``2`` -打开文件进行写操作。如果文件不存在则会创建该文件，如果存在则会截断。 +打开文件进行写入操作。如果文件不存在则会创建该文件，如果存在则会截断。 \ **注意：**\ 创建文件必须在已有目录中执行。如果要递归创建文件路径中的目录，见 :ref:`DirAccess.make_dir_recursive()`\ 。 @@ -250,7 +256,7 @@ enum **ModeFlags**: :ref:`🔗` :ref:`ModeFlags` **READ_WRITE** = ``3`` -打开文件用于读写操作。不截断文件。光标位于文件的开头。 +打开文件进行读写操作。不会截断文件。文件游标位于文件的开头。 .. _class_FileAccess_constant_WRITE_READ: @@ -258,7 +264,7 @@ enum **ModeFlags**: :ref:`🔗` :ref:`ModeFlags` **WRITE_READ** = ``7`` -打开文件进行读写操作。如果文件不存在则会创建该文件，如果存在则会截断。光标位于文件的开头。 +打开文件进行读写操作。如果文件不存在则会创建该文件，如果存在则会截断。文件游标位于文件的开头。 \ **注意：**\ 创建文件必须在已有目录中执行。如果要递归创建文件路径中的目录，见 :ref:`DirAccess.make_dir_recursive()`\ 。 @@ -440,9 +446,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` 如果为 ``true``\ ，则文件用大端\ `字节序 `__\ 读取。如果为 ``false``\ ，则文件以小端字节序读取。如果有疑问，请将其保留为 ``false``\ ，因为大多数文件都是用小端字节序编写的。 -\ **注意：**\ :ref:`big_endian` 只与文件格式有关，与 CPU 类型无关。CPU 字节序不会影响写入文件的默认字节序。 - -\ **注意：**\ 每当打开文件时，该选项总是被重置为 ``false``\ 。因此，必须在打开文件\ *之后*\ 设置 :ref:`big_endian`\ ，而不是之前。 +\ **注意：**\ 每当打开文件时，该选项总会重置为系统字节序，在支持的所有平台上均为小端序。因此必须在打开文件\ *之后*\ 设置 :ref:`big_endian`\ ，而不是之前。 .. rst-class:: classref-section-separator @@ -554,7 +558,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`int` **get_8**\ (\ ) |const| :ref:`🔗` -以整数形式返回文件中接下来的 8 位。请参阅 :ref:`store_8()`\ ，详细了解哪些值可以通过这种方式存储和检索。 +以整数形式返回文件中接下来的 8 位。文件游标前进 1 个字节。请参阅 :ref:`store_8()`\ ，详细了解哪些值可以通过这种方式存储和检索。 .. rst-class:: classref-item-separator @@ -566,7 +570,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`int` **get_16**\ (\ ) |const| :ref:`🔗` -以整数形式返回文件中接下来的 16 位。请参阅 :ref:`store_16()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 +以整数形式返回文件中接下来的 16 位。文件游标前进 2 个字节。请参阅 :ref:`store_16()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 .. rst-class:: classref-item-separator @@ -578,7 +582,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`int` **get_32**\ (\ ) |const| :ref:`🔗` -以整数形式返回文件中接下来的 32 位。请参阅\ :ref:`store_32()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 +以整数形式返回文件中接下来的 32 位。文件游标前进 4 个字节。请参阅 :ref:`store_32()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 .. rst-class:: classref-item-separator @@ -590,7 +594,19 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`int` **get_64**\ (\ ) |const| :ref:`🔗` -以整数形式返回文件中接下来的 64 位。请参阅 :ref:`store_64()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 +以整数形式返回文件中接下来的 64 位。文件游标前进 8 个字节。请参阅 :ref:`store_64()`\ ，以获取有关可以通过这种方式存储和检索哪些值的详细信息。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileAccess_method_get_access_time: + +.. rst-class:: classref-method + +:ref:`int` **get_access_time**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` + +返回文件 ``file`` 的最后修改时间，使用 Unix 时间戳格式，出错时返回 ``0``\ 。这个 Unix 时间戳可以用 :ref:`Time` 单例转换为其他格式。 .. rst-class:: classref-item-separator @@ -602,7 +618,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`String` **get_as_text**\ (\ skip_cr\: :ref:`bool` = false\ ) |const| :ref:`🔗` -以 :ref:`String` 形式返回整个文件。文本会按照 UTF-8 编码解析。 +以 :ref:`String` 形式返回整个文件。文本会按照 UTF-8 编码解析。忽略文件游标，不会对其产生影响。 如果 ``skip_cr`` 为 ``true``\ ，解析 UTF-8 时会忽略回车符（\ ``\r``\ ，CR），因此只使用换行符（\ ``\n``\ ，LF）表示新一行的开始（Unix 规范）。 @@ -616,7 +632,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`PackedByteArray` **get_buffer**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` -将文件中接下来的 ``length`` 个字节作为 :ref:`PackedByteArray` 返回。 +将文件中接下来的 ``length`` 个字节作为 :ref:`PackedByteArray` 返回。文件游标前进 ``length`` 个字节。 .. rst-class:: classref-item-separator @@ -630,7 +646,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` 以 CSV（逗号分隔值）格式返回文件的下一个值。可以传递不同的分隔符 ``delim``\ ，以使用默认 ``","``\ （逗号）以外的其他分隔符。这个分隔符必须为一个字符长，且不能是双引号。 -文本被解析为 UTF-8 编码。如果文本值包含分隔符，则它们必须用双引号引起来。文本值中的双引号可以通过将它们的出现次数加倍来转义。 +文本被解析为 UTF-8 编码。如果文本值包含分隔符，则它们必须用双引号引起来。文本值中的双引号可以通过将它们的出现次数加倍来转义。文件游标前进至行尾的换行符后。 例如，以下 CSV 行是有效的，每行将被正确解析为两个字符串： @@ -652,7 +668,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`float` **get_double**\ (\ ) |const| :ref:`🔗` -将文件中接下来的 64 位作为浮点数返回。 +将文件中接下来的 64 位作为浮点数返回。文件游标前进 8 个字节。 .. rst-class:: classref-item-separator @@ -704,7 +720,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`float` **get_float**\ (\ ) |const| :ref:`🔗` -将文件中接下来的 32 位作为浮点数返回。 +将文件中接下来的 32 位作为浮点数返回。文件游标前进 4 个字节。 .. rst-class:: classref-item-separator @@ -716,7 +732,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`float` **get_half**\ (\ ) |const| :ref:`🔗` -将文件中接下来的 16 位作为半精度浮点数返回。 +将文件中接下来的 16 位作为半精度浮点数返回。文件游标前进 2 个字节。 .. rst-class:: classref-item-separator @@ -754,7 +770,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`String` **get_line**\ (\ ) |const| :ref:`🔗` -以 :ref:`String` 的形式返回文件中的下一行。返回的字符串不包含换行符（\ ``\n``\ ）和回车符（\ ``\r``\ ），但是会包含开头和结尾的其他空白字符。 +以 :ref:`String` 的形式返回文件中的下一行。返回的字符串不包含换行符（\ ``\n``\ ）和回车符（\ ``\r``\ ），但是会包含开头和结尾的其他空白字符。文件游标前进至行尾的换行符之后。 文本按照 UTF-8 编码规则进行解析。 @@ -804,9 +820,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`String` **get_pascal_string**\ (\ ) :ref:`🔗` -返回文件中按照 Pascal 格式保存的 :ref:`String` 字符串。 +返回文件中的一个以 Pascal 格式保存的 :ref:`String`\ ，即字符串的长度在开头显式存储。见 :ref:`store_pascal_string()`\ 。可能包含换行符。文件游标前进至读取的字节之后。 -将按照 UTF-8 编码解析文本。 +文本按照 UTF-8 编码规则进行解析。 .. rst-class:: classref-item-separator @@ -842,7 +858,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`int` **get_position**\ (\ ) |const| :ref:`🔗` -返回文件光标的位置。 +返回文件游标的位置，单位为字节，相对于文件的开头。文件读写游标由 :ref:`seek()` 和 :ref:`seek_end()` 设置，读写操作会导致游标前进。 .. rst-class:: classref-item-separator @@ -868,7 +884,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`float` **get_real**\ (\ ) |const| :ref:`🔗` -将文件中接下来的若干位以浮点数形式返回。 +返回文件中后续数据构成的一个浮点数。文件游标前进 4 个或 8 个字节，取决于保存文件的 Godot 构建所使用的精度。 + +如果保存文件的是使用 ``precision=single`` 编译的 Godot 构建（默认），则会从文件中读取 32 位。否则如果是使用 ``precision=double`` 编译的，那么读取的就是 64 位。 .. rst-class:: classref-item-separator @@ -886,6 +904,18 @@ flags **UnixPermissionFlags**: :ref:`🔗` ---- +.. _class_FileAccess_method_get_size: + +.. rst-class:: classref-method + +:ref:`int` **get_size**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` + +返回文件大小，单位为字节，出错时为 ``-1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileAccess_method_get_unix_permissions: .. rst-class:: classref-method @@ -906,9 +936,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) |const| :ref:`🔗` -返回文件中的下一个 :ref:`Variant` 值。如果 ``allow_objects`` 为 ``true``\ ，则允许解码对象。 +返回文件中的下一个 :ref:`Variant` 值。如果 ``allow_objects`` 为 ``true``\ ，则允许解码对象。这会使文件光标前进读取的字节数。 -在内部，这使用与 :ref:`@GlobalScope.bytes_to_var()` 方法相同的解码机制。 +在内部，这使用与 :ref:`@GlobalScope.bytes_to_var()` 方法相同的解码机制，如在\ :doc:`二进制序列化 API <../tutorials/io/binary_serialization_api>` 文档中所述。 \ **警告：**\ 反序列化得到的对象可能包含被执行的代码。如果序列化的对象来自不受信任的来源，请不要使用这个选项，以避免潜在的安全威胁，如远程代码执行。 @@ -1006,7 +1036,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` |void| **seek**\ (\ position\: :ref:`int`\ ) :ref:`🔗` -将文件的读/写光标改变到指定的位置（从文件开始的字节数）。 +将文件读写游标修改至指定位置（单位为字节，相对于文件的开头）。修改 :ref:`get_position()` 的返回值。 .. rst-class:: classref-item-separator @@ -1018,9 +1048,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` |void| **seek_end**\ (\ position\: :ref:`int` = 0\ ) :ref:`🔗` -将文件的读/写光标改变到指定的位置（从文件的末端算起，以字节为单位）。 +将文件读写游标修改至指定位置（单位为字节，相对于文件的末尾）。修改 :ref:`get_position()` 的返回值。 -\ **注意：**\ 这是一个偏移量，所以你应该使用负数，否则光标会在文件的末端。 +\ **注意：**\ 指定的是偏移量，因此应当使用负数，否则文件游标会处于文件末尾。 .. rst-class:: classref-item-separator @@ -1074,7 +1104,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_8**\ (\ value\: :ref:`int`\ ) :ref:`🔗` -将一个整数以 8 位形式存储在文件中。 +将一个整数以 8 位形式存储在文件中。文件游标前进 1 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ ``value`` 应该位于 ``[0, 255]`` 的区间内。任何其他的值都会溢出并环绕。 @@ -1092,7 +1122,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_16**\ (\ value\: :ref:`int`\ ) :ref:`🔗` -将一个整数以 16 位形式存储到文件中。 +将一个整数以 16 位形式存储到文件中。文件游标前进 2 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ ``value`` 应该位于 ``[0, 2^16 - 1]`` 区间内。任何其他的值都会溢出并进行环绕。 @@ -1107,10 +1137,10 @@ flags **UnixPermissionFlags**: :ref:`🔗` const MAX_15B = 1 << 15 const MAX_16B = 1 << 16 - + func unsigned16_to_signed(unsigned): return (unsigned + MAX_15B) % MAX_16B - MAX_15B - + func _ready(): var f = FileAccess.open("user://file.dat", FileAccess.WRITE_READ) f.store_16(-42) # 发生环绕，存储 65494 (2^16 - 42)。 @@ -1147,7 +1177,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_32**\ (\ value\: :ref:`int`\ ) :ref:`🔗` -将一个整数以 32 位形式存储到文件中。 +将一个整数以 32 位形式存储到文件中。文件游标前进 4 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ ``value`` 应该位于 ``[0, 2^32 - 1]`` 区间内。任何其他的值都会溢出并环绕。 @@ -1165,7 +1195,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_64**\ (\ value\: :ref:`int`\ ) :ref:`🔗` -将一个整数以 64 位形式存储到文件中。 +将一个整数以 64 位形式存储到文件中。文件游标前进 8 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ ``value`` 必须位于 ``[-2^63, 2^63 - 1]`` 的区间内（即有效的 :ref:`int` 值）。 @@ -1181,7 +1211,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` -将给定的字节数组存储到文件中。 +将给定的字节数组存储在文件中。文件游标前进写入的字节数。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1197,7 +1227,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` 将给定的 :ref:`PackedStringArray` 作为 CSV（逗号分隔值）格式的行存储在文件中。你可以传递不同的分隔符 ``delim`` 以使用默认 ``","``\ （逗号）以外的其他分隔符。此分隔符的长度必须为一个字符。 -将使用 UTF-8 编码文本。 +将使用 UTF-8 编码文本。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1211,7 +1241,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_double**\ (\ value\: :ref:`float`\ ) :ref:`🔗` -将一个浮点数以 64 位的形式存储到文件中。 +将一个浮点数以 64 位的形式存储到文件中。文件游标前进 8 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1225,7 +1255,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_float**\ (\ value\: :ref:`float`\ ) :ref:`🔗` -将一个浮点数以 32 位的形式存储到文件中。 +将一个浮点数以 32 位的形式存储到文件中。文件游标前进 4 个字节。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1239,7 +1269,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_half**\ (\ value\: :ref:`float`\ ) :ref:`🔗` -将一个半精度浮点数以 16 位的形式存储到文件中。 +将一个半精度浮点数以 16 位的形式存储到文件中。文件游标前进 2 个字节。如果操作成功则返回 ``true``\ 。 + +\ **注意：**\ 出错时，文件位置标识符的取值不确定。 .. rst-class:: classref-item-separator @@ -1251,7 +1283,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_line**\ (\ line\: :ref:`String`\ ) :ref:`🔗` -将 ``line`` 存储到文件中，后加一个换行符（\ ``\n``\ ），文本编码为 UTF-8。 +将 ``line`` 存储到文件中，后跟一个换行符（\ ``\n``\ ），文本使用 UTF-8 编码。文件游标前进该行长度，至换行符后。写入的字节数取决于 UTF-8 编码后的字节，可能与 :ref:`String.length()` 不同，后者计算的是 UTF-32 码位的数量。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1265,9 +1297,7 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_pascal_string**\ (\ string\: :ref:`String`\ ) :ref:`🔗` -将给定的 :ref:`String` 以 Pascal 格式存储在文件中（即同时存储字符串的长度）。 - -将使用 UTF-8 编码文本。 +将给定的 :ref:`String` 作为一行存储到文件中，使用 Pascal 格式（即同时存储字符串的长度）。文本使用 UTF-8 编码。文件游标的前进量为写入的字节数，取决于 UTF-8 编码后的字节，可能与 :ref:`String.length()` 不同，后者计算的是 UTF-32 码位的数量。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1281,7 +1311,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_real**\ (\ value\: :ref:`float`\ ) :ref:`🔗` -将一个浮点数存储到文件中。 +将一个浮点数存储到文件中。文件游标前进 4 个或 8 个字节，取决于当前 Godot 构建所使用的精度。 + +如果所用的 Godot 构建在编译时使用了 ``precision=single`` 选项（默认），则该方法保存的是 32 位 float。否则如果编译时使用了 ``precision=double`` 选项，则保存的是 64 位 float。如果操作成功则返回 ``true``\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1295,9 +1327,9 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_string**\ (\ string\: :ref:`String`\ ) :ref:`🔗` -将 ``string`` 存储到文件中，不带换行符（\ ``\n``\ ），文本编码为 UTF-8。 +将 ``string`` 存储到文件中，不带换行符（\ ``\n``\ ），文本使用 UTF-8 编码。文件游标的前进量为 UTF-8 编码后的字节数，可能与 :ref:`String.length()` 不同，后者计算的是 UTF-32 码位的数量。如果操作成功则返回 ``true``\ 。 -\ **注意：**\ 本方法是用来写入文本文件的。字符串会被存储为 UTF-8 编码的缓冲区，不带字符串长度或末尾零，这意味着它不能被轻易加载回来。如果想在二进制文件中存储一个可检索的字符串，可以考虑改用 :ref:`store_pascal_string()`\ 。对于从文本文件中检索字符串，可以使用 ``get_buffer(length).get_string_from_utf8()``\ （如果知道长度）或 :ref:`get_as_text()`\ 。 +\ **注意：**\ 该方法适用于写入文本文件。字符串以 UTF-8 编码的缓冲区形式存储，不带字符串长度，不以零结尾，加载并非易事。如果你想要在二进制文件中存储便于读取的字符串，请考虑改用 :ref:`store_pascal_string()`\ 。从文本文件中读取字符串可以使用 ``get_buffer(length).get_string_from_utf8()``\ （前提是知道长度）或 :ref:`get_as_text()`\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 @@ -1311,15 +1343,16 @@ flags **UnixPermissionFlags**: :ref:`🔗` :ref:`bool` **store_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) :ref:`🔗` -将任意 Variant 值存储到文件中。如果 ``full_objects`` 为 ``true``\ ，则允许编码对象（并且可能包含代码）。 +将任意 Variant 值存储到文件中。如果 ``full_objects`` 为 ``true``\ ，则允许将对象进行编码（可能包含代码）。文件游标的前进量为写入的字节数。如果操作成功则返回 ``true``\ 。 -内部使用与 :ref:`@GlobalScope.var_to_bytes()` 方法相同的编码机制。 +内部使用的编码机制与 :ref:`@GlobalScope.var_to_bytes()` 方法相同，见《\ :doc:`二进制序列化 API <../tutorials/io/binary_serialization_api>` 》文档。 -\ **注意：**\ 并非所有属性都包括在内。只有配置了 :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` 标志集的属性才会被序列化。可以通过覆盖类中的 :ref:`Object._get_property_list()` 方法来向属性添加新的使用标志。还可以通过调用 :ref:`Object._get_property_list()` 来检查属性使用的配置方式。有关可能的使用标志，请参阅 :ref:`PropertyUsageFlags`\ 。 +\ **注意：**\ 不是所有属性都会包含在内。只会对设置了 :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` 标志的属性进行序列化。在你的类中覆盖 :ref:`Object._get_property_list()` 可以为属性添加新的用法标志。你也可以调用 :ref:`Object._get_property_list()` 查看属性用法的设置情况。可能的用法标志见 :ref:`PropertyUsageFlags`\ 。 \ **注意：**\ 出错时，文件位置标识符的取值不确定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_filedialog.rst b/classes/zh_CN/class_filedialog.rst index 71de25bca7..f8777afadb 100644 --- a/classes/zh_CN/class_filedialog.rst +++ b/classes/zh_CN/class_filedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileDialog.xml. .. _class_FileDialog: @@ -29,39 +29,53 @@ FileDialog .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Access` | :ref:`access` | ``0`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_dir` | | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_file` | | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_path` | | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog`) | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`FileMode` | :ref:`file_mode` | ``4`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filename_filter` | ``""`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | ok_button_text | ``"Save"`` (overrides :ref:`AcceptDialog`) | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`option_count` | ``0`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`root_subfolder` | ``""`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | size | ``Vector2i(640, 360)`` (overrides :ref:`Window`) | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`use_native_dialog` | ``false`` | - +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Access` | :ref:`access` | ``0`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`current_dir` | | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`current_file` | | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`current_path` | | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog`) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`DisplayMode` | :ref:`display_mode` | ``0`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`favorites_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_filter_toggle_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`FileMode` | :ref:`file_mode` | ``4`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_sort_options_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filename_filter` | ``""`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`folder_creation_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hidden_files_toggle_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`layout_toggle_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`option_count` | ``0`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`recent_list_enabled` | ``true`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`root_subfolder` | ``""`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | size | ``Vector2i(640, 360)`` (overrides :ref:`Window`) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_native_dialog` | ``false`` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -96,6 +110,10 @@ FileDialog +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`invalidate`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_customization_flag_enabled`\ (\ flag\: :ref:`Customization`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_customization_flag_enabled`\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | @@ -118,20 +136,38 @@ FileDialog +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`folder_icon_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`thumbnail_size` | ``64`` | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`back_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`create_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`favorite` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`favorite_down` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`favorite_up` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`file` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`file_thumbnail` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`folder_thumbnail` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`forward_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`list_mode` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`parent_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`reload` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`sort` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`thumbnail_mode` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`toggle_filename_filter` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`toggle_hidden` | | @@ -279,6 +315,112 @@ enum **Access**: :ref:`🔗` 该对话框允许访问文件系统上的文件。 +.. rst-class:: classref-item-separator + +---- + +.. _enum_FileDialog_DisplayMode: + +.. rst-class:: classref-enumeration + +enum **DisplayMode**: :ref:`🔗` + +.. _class_FileDialog_constant_DISPLAY_THUMBNAILS: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisplayMode` **DISPLAY_THUMBNAILS** = ``0`` + +该对话框以缩略图网格的形式显示文件。请使用 :ref:`thumbnail_size` 调整缩略图的大小。 + +.. _class_FileDialog_constant_DISPLAY_LIST: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisplayMode` **DISPLAY_LIST** = ``1`` + +该对话框以文件名列表的形式显示文件。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_FileDialog_Customization: + +.. rst-class:: classref-enumeration + +enum **Customization**: :ref:`🔗` + +.. _class_FileDialog_constant_CUSTOMIZATION_HIDDEN_FILES: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_HIDDEN_FILES** = ``0`` + +切换收藏按钮是否可见，以及对话框左侧的收藏列表是否可见。 + +等价于 :ref:`hidden_files_toggle_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_CREATE_FOLDER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_CREATE_FOLDER** = ``1`` + +如果启用，则会显示新建目录按钮（使用 :ref:`FILE_MODE_OPEN_DIR`\ 、\ :ref:`FILE_MODE_OPEN_ANY`\ 、\ :ref:`FILE_MODE_SAVE_FILE` 时有效）。 + +等价于 :ref:`folder_creation_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_FILE_FILTER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_FILE_FILTER** = ``2`` + +如果启用，则会显示文件筛选开关按钮。 + +等价于 :ref:`file_filter_toggle_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_FILE_SORT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_FILE_SORT** = ``3`` + +如果启用，则会显示文件排序选项按钮。 + +等价于 :ref:`file_sort_options_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_FAVORITES: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_FAVORITES** = ``4`` + +如果启用，则会显示收藏开关按钮和对话框左侧的收藏列表。 + +等价于 :ref:`favorites_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_RECENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_RECENT** = ``5`` + +如果启用，则会显示对话框左侧的最近目录列表。 + +等价于 :ref:`recent_list_enabled`\ 。 + +.. _class_FileDialog_constant_CUSTOMIZATION_LAYOUT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Customization` **CUSTOMIZATION_LAYOUT** = ``6`` + +如果启用，则会显示布局切换按钮（列表、缩略图）。 + +等价于 :ref:`layout_toggle_enabled`\ 。 + .. rst-class:: classref-section-separator ---- @@ -299,7 +441,7 @@ enum **Access**: :ref:`🔗` - |void| **set_access**\ (\ value\: :ref:`Access`\ ) - :ref:`Access` **get_access**\ (\ ) -文件系统访问范围。请参阅 :ref:`Access` 常量。 +文件系统访问范围。 \ **警告：**\ 在 Web 构建中，FileDialog 无法访问主机文件系统。在沙盒 Linux 和 macOS 环境中，会自动使用 :ref:`use_native_dialog` 来允许对主机文件系统进行有限的访问。 @@ -360,6 +502,57 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_property_display_mode: + +.. rst-class:: classref-property + +:ref:`DisplayMode` **display_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode`\ ) +- :ref:`DisplayMode` **get_display_mode**\ (\ ) + +对话框文件列表的显示模式。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_favorites_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **favorites_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示收藏开关按钮和对话框左侧的收藏列表。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_file_filter_toggle_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **file_filter_toggle_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示文件筛选开关按钮。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_property_file_mode: .. rst-class:: classref-property @@ -371,7 +564,24 @@ enum **Access**: :ref:`🔗` - |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) - :ref:`FileMode` **get_file_mode**\ (\ ) -对话框的打开或保存模式，会影响选择行为。见 :ref:`FileMode`\ 。 +对话框的打开或保存模式，会影响选择行为。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_file_sort_options_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **file_sort_options_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示文件排序选项按钮。 .. rst-class:: classref-item-separator @@ -417,6 +627,57 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_property_folder_creation_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **folder_creation_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示用于新建文件夹的按钮（适用于 :ref:`FILE_MODE_OPEN_DIR`\ 、\ :ref:`FILE_MODE_OPEN_ANY`\ 、\ :ref:`FILE_MODE_SAVE_FILE`\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_hidden_files_toggle_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **hidden_files_toggle_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示隐藏文件开关按钮。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_layout_toggle_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **layout_toggle_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会显示布局切换按钮（列表、缩略图）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_property_mode_overrides_title: .. rst-class:: classref-property @@ -451,6 +712,23 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_property_recent_list_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **recent_list_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| + +如果为 ``true``\ ，则会在对话框左侧显示最近目录列表。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_property_root_subfolder: .. rst-class:: classref-property @@ -502,7 +780,7 @@ enum **Access**: :ref:`🔗` 如果为 ``true`` 并且当前 :ref:`DisplayServer` 支持原生对话框，那么就会使用操作系统原生对话框代替自定义对话框。 -\ **注意：**\ 在 Android 上只有使用 :ref:`ACCESS_FILESYSTEM` 时才支持。使用 :ref:`ACCESS_RESOURCES`\ 、\ :ref:`ACCESS_USERDATA` 等访问模式时系统会回退至自定义 FileDialog。 +\ **注意：**\ 在 Android 上，它只在 Android 10+ 设备且使用 :ref:`ACCESS_FILESYSTEM` 时才支持。使用 :ref:`ACCESS_RESOURCES`\ 、\ :ref:`ACCESS_USERDATA` 等访问模式时系统会回退至自定义 FileDialog。 \ **注意：**\ 在 Linux 和 macOS 上，沙盒应用程序始终使用原生对话框来访问主机文件系统。 @@ -677,6 +955,30 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_method_is_customization_flag_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization`\ ) |const| :ref:`🔗` + +如果指定的 ``flag`` 已启用，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_method_set_customization_flag_enabled: + +.. rst-class:: classref-method + +|void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +开关自定义标志 ``flag``\ ，允许自定义该 **FileDialog** 的特性。选项见 :ref:`Customization`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_method_set_option_default: .. rst-class:: classref-method @@ -754,6 +1056,18 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_constant_thumbnail_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **thumbnail_size** = ``64`` :ref:`🔗` + +启用 :ref:`DISPLAY_THUMBNAILS` 时的缩略图图标大小。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_back_folder: .. rst-class:: classref-themeproperty @@ -778,6 +1092,42 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_icon_favorite: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **favorite** :ref:`🔗` + +收藏文件夹按钮得自定义图标。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_theme_icon_favorite_down: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **favorite_down** :ref:`🔗` + +将收藏项向下移动的按钮的自定义图标。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_theme_icon_favorite_up: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **favorite_up** :ref:`🔗` + +将收藏项向上移动的按钮的自定义图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_file: .. rst-class:: classref-themeproperty @@ -790,6 +1140,18 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_icon_file_thumbnail: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **file_thumbnail** :ref:`🔗` + +缩略图模式下，文件的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_folder: .. rst-class:: classref-themeproperty @@ -802,6 +1164,18 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_icon_folder_thumbnail: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **folder_thumbnail** :ref:`🔗` + +缩略图模式下，文件夹的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_forward_folder: .. rst-class:: classref-themeproperty @@ -814,6 +1188,18 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_icon_list_mode: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **list_mode** :ref:`🔗` + +用来启用列表模式的按钮的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_parent_folder: .. rst-class:: classref-themeproperty @@ -838,6 +1224,30 @@ enum **Access**: :ref:`🔗` ---- +.. _class_FileDialog_theme_icon_sort: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **sort** :ref:`🔗` + +排序选项按钮的自定义图标。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_theme_icon_thumbnail_mode: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **thumbnail_mode** :ref:`🔗` + +用来启用缩略图模式的按钮的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_toggle_filename_filter: .. rst-class:: classref-themeproperty @@ -859,6 +1269,7 @@ enum **Access**: :ref:`🔗` 切换隐藏按钮的自定义图标。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_filesystemdock.rst b/classes/zh_CN/class_filesystemdock.rst index be103c0db5..212f8de546 100644 --- a/classes/zh_CN/class_filesystemdock.rst +++ b/classes/zh_CN/class_filesystemdock.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FileSystemDock.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileSystemDock.xml. .. _class_FileSystemDock: @@ -194,6 +194,7 @@ Godot 编辑器中用于管理项目文件的停靠面板。 移除一个 :ref:`EditorResourceTooltipPlugin`\ 。如果该插件尚未添加，则失败。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_float.rst b/classes/zh_CN/class_float.rst index 5d0d365d83..2e5ab38a98 100644 --- a/classes/zh_CN/class_float.rst +++ b/classes/zh_CN/class_float.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/float.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/float.xml. .. _class_float: @@ -615,6 +615,7 @@ float 返回该 **float** 的相反数。如果为正数，则将该数变为负数。如果为负数，则将该数变为正数。对于浮点数，数字零既可以是正数，也可以是负数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_flowcontainer.rst b/classes/zh_CN/class_flowcontainer.rst index a76fb53aaf..7d278445d3 100644 --- a/classes/zh_CN/class_flowcontainer.rst +++ b/classes/zh_CN/class_flowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FlowContainer.xml. .. _class_FlowContainer: @@ -279,6 +279,7 @@ enum **LastWrapAlignmentMode**: :ref:`🔗` 的高度决定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_fogvolume.rst b/classes/zh_CN/class_fogvolume.rst index 5802cf56bc..70562f3aa0 100644 --- a/classes/zh_CN/class_fogvolume.rst +++ b/classes/zh_CN/class_fogvolume.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FogVolume.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FogVolume.xml. .. _class_FogVolume: @@ -109,6 +109,7 @@ FogVolume \ **注意：**\ 如果 :ref:`shape` 为 :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE` 或 :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER`\ ，圆锥体/圆柱体将被调整以适应该大小。不支持通过 :ref:`size` 属性对圆锥体/圆柱体形状进行非均匀缩放，但可以改为缩放该 **FogVolume** 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_foldablecontainer.rst b/classes/zh_CN/class_foldablecontainer.rst new file mode 100644 index 0000000000..568481f982 --- /dev/null +++ b/classes/zh_CN/class_foldablecontainer.rst @@ -0,0 +1,602 @@ +:github_url: hide + +.. meta:: + :keywords: expandable, collapsible, collapse + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FoldableContainer.xml. + +.. _class_FoldableContainer: + +FoldableContainer +================= + +**继承：** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +能够展开、折叠的容器。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +能够展开、折叠的容器，标题中可以添加按钮等控件。 + +标题可以放在容器的顶部或底部。 + +点击标题或在聚焦时按下 ``ui_accept`` 可以将容器展开或折叠。 + +容器折叠时子控件节点隐藏。忽略非控件子节点。 + +可以与其他 FoldableContainer 分组，见 :ref:`foldable_group` 和 :ref:`FoldableGroup`\ 。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FoldableGroup` | :ref:`foldable_group` | | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`bool` | :ref:`folded` | ``false`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`title` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`title_alignment` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TitlePosition` | :ref:`title_position` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`title_text_direction` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`title_text_overrun_behavior` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_title_bar_control`\ (\ control\: :ref:`Control`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`expand`\ (\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fold`\ (\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_title_bar_control`\ (\ control\: :ref:`Control`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +主题属性 +-------- + +.. table:: + :widths: auto + + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`collapsed_font_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`hover_font_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`h_separation` | ``2`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Font` | :ref:`font` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`font_size` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow_mirrored` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow_mirrored` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_collapsed_hover_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_collapsed_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_hover_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_FoldableContainer_signal_folding_changed: + +.. rst-class:: classref-signal + +**folding_changed**\ (\ is_folded\: :ref:`bool`\ ) :ref:`🔗` + +容器折叠/展开时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_FoldableContainer_TitlePosition: + +.. rst-class:: classref-enumeration + +enum **TitlePosition**: :ref:`🔗` + +.. _class_FoldableContainer_constant_POSITION_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`TitlePosition` **POSITION_TOP** = ``0`` + +标题出现在容器顶部。 + +.. _class_FoldableContainer_constant_POSITION_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`TitlePosition` **POSITION_BOTTOM** = ``1`` + +标题出现在容器底部。同时会让所有 StyleBox 垂直翻转。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_FoldableContainer_property_foldable_group: + +.. rst-class:: classref-property + +:ref:`FoldableGroup` **foldable_group** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_foldable_group**\ (\ value\: :ref:`FoldableGroup`\ ) +- :ref:`FoldableGroup` **get_foldable_group**\ (\ ) + +与容器关联的 :ref:`FoldableGroup`\ 。多个 **FoldableContainer** 节点具有相同的分组时，只允许有一个处于展开状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_folded: + +.. rst-class:: classref-property + +:ref:`bool` **folded** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_folded**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_folded**\ (\ ) + +如果为 ``true``\ ，则会折叠容器折叠，隐藏所有子节点。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_language: + +.. rst-class:: classref-property + +:ref:`String` **language** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) + +语言代码，用于文本塑形算法。如果留空则使用当前区域设置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title: + +.. rst-class:: classref-property + +:ref:`String` **title** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) + +容器的标题文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_alignment: + +.. rst-class:: classref-property + +:ref:`HorizontalAlignment` **title_alignment** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_title_alignment**\ (\ ) + +标题的水平文本对齐方式。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_position: + +.. rst-class:: classref-property + +:ref:`TitlePosition` **title_position** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_position**\ (\ value\: :ref:`TitlePosition`\ ) +- :ref:`TitlePosition` **get_title_position**\ (\ ) + +标题的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_text_direction: + +.. rst-class:: classref-property + +:ref:`TextDirection` **title_text_direction** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_title_text_direction**\ (\ ) + +标题的文本书写方向。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_text_overrun_behavior: + +.. rst-class:: classref-property + +:ref:`OverrunBehavior` **title_text_overrun_behavior** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_title_text_overrun_behavior**\ (\ ) + +定义标题在文本比可用空间更长时的行为。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_FoldableContainer_method_add_title_bar_control: + +.. rst-class:: classref-method + +|void| **add_title_bar_control**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` + +添加放置在容器标题旁的 :ref:`Control`\ ，遮挡可点击区域。主要用途是添加 :ref:`Button` 节点，但可以是任何 :ref:`Control`\ 。 + +控件会被添加为该容器的子节点，必要时会从之前的父节点中移除。这些控件是右对齐的，最先添加的控件位于最左侧。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_expand: + +.. rst-class:: classref-method + +|void| **expand**\ (\ ) :ref:`🔗` + +展开容器，发出 :ref:`folding_changed`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_fold: + +.. rst-class:: classref-method + +|void| **fold**\ (\ ) :ref:`🔗` + +折叠容器，发出 :ref:`folding_changed`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_remove_title_bar_control: + +.. rst-class:: classref-method + +|void| **remove_title_bar_control**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` + +移除使用 :ref:`add_title_bar_control()` 添加的 :ref:`Control`\ 。该节点不会自动释放，你需要使用 :ref:`Node.queue_free()`\ 。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +主题属性说明 +------------ + +.. _class_FoldableContainer_theme_color_collapsed_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **collapsed_font_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +折叠时的标题字体颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` + +展开时的标题字体颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_font_outline_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +标题字体轮廓颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_hover_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **hover_font_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` + +标题字体悬停颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_constant_h_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **h_separation** = ``2`` :ref:`🔗` + +标题的图标和文本之间以及标题栏控件之间的水平间距。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_constant_outline_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **outline_size** = ``0`` :ref:`🔗` + +标题字体轮廓大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_font_font: + +.. rst-class:: classref-themeproperty + +:ref:`Font` **font** :ref:`🔗` + +标题字体。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_font_size_font_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **font_size** :ref:`🔗` + +标题字体大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_expanded_arrow: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **expanded_arrow** :ref:`🔗` + +展开时使用的标题图标。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_expanded_arrow_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **expanded_arrow_mirrored** :ref:`🔗` + +展开时使用的标题图标（用于底部标题）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_folded_arrow: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **folded_arrow** :ref:`🔗` + +折叠时使用的标题图标（用于从左至右布局）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_folded_arrow_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **folded_arrow_mirrored** :ref:`🔗` + +展开时使用的标题图标（用于从右至左布局）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **focus** :ref:`🔗` + +**FoldableContainer** 拥有 GUI 焦点时使用的背景。\ :ref:`focus` :ref:`StyleBox` 显示在基础 :ref:`StyleBox` *之上*\ ，所以应该使用部分透明的 :ref:`StyleBox`\ ，确保基础 :ref:`StyleBox` 仍然可见。代表轮廓或下划线的 :ref:`StyleBox` 可以很好地实现这个目的。要禁用聚焦的视觉效果，请指定 :ref:`StyleBoxEmpty` 资源。请注意，禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性，所以出于可访问性的原因，不建议这样做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel** :ref:`🔗` + +**FoldableContainer** 的默认背景。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_collapsed_hover_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_collapsed_hover_panel** :ref:`🔗` + +处于折叠状态下，鼠标光标进入标题区域时使用的背景。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_collapsed_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_collapsed_panel** :ref:`🔗` + +处于折叠状态下，\ **FoldableContainer** 标题的默认背景。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_hover_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_hover_panel** :ref:`🔗` + +处于展开状态下，鼠标光标进入标题区域时使用的背景。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_panel** :ref:`🔗` + +处于展开状态下，\ **FoldableContainer** 标题的默认背景。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_foldablegroup.rst b/classes/zh_CN/class_foldablegroup.rst new file mode 100644 index 0000000000..800a9bb12d --- /dev/null +++ b/classes/zh_CN/class_foldablegroup.rst @@ -0,0 +1,131 @@ +:github_url: hide + +.. meta:: + :keywords: expandable, collapsible, collapse + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FoldableGroup.xml. + +.. _class_FoldableGroup: + +FoldableGroup +============= + +**继承：** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +一组可折叠容器，不允许同一时间有超过一个容器处于展开状态。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +一组派生自 :ref:`FoldableContainer` 的节点的分组。同一时间只能有一个容器处于展开状态。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_folding_all` | ``false`` | + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`FoldableContainer`\] | :ref:`get_containers`\ (\ ) |const| | + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`FoldableContainer` | :ref:`get_expanded_container`\ (\ ) |const| | + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_FoldableGroup_signal_expanded: + +.. rst-class:: classref-signal + +**expanded**\ (\ container\: :ref:`FoldableContainer`\ ) :ref:`🔗` + +当该组中的某个容器被展开时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_FoldableGroup_property_allow_folding_all: + +.. rst-class:: classref-property + +:ref:`bool` **allow_folding_all** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_allow_folding_all**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_folding_all**\ (\ ) + +如果为 ``true``\ ，则可以折叠 FoldableGroup 中的所有容器。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_FoldableGroup_method_get_containers: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`FoldableContainer`\] **get_containers**\ (\ ) |const| :ref:`🔗` + +返回一个 :ref:`Array`\ ，其中的元素是使用该 FoldableGroup 的 :ref:`FoldableContainer`\ （见 :ref:`FoldableContainer.foldable_group`\ ）。等价于 :ref:`ButtonGroup`\ ，但适用于 FoldableContainer。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableGroup_method_get_expanded_container: + +.. rst-class:: classref-method + +:ref:`FoldableContainer` **get_expanded_container**\ (\ ) |const| :ref:`🔗` + +返回当前展开的容器。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_font.rst b/classes/zh_CN/class_font.rst index b34d42eacd..49407f153c 100644 --- a/classes/zh_CN/class_font.rst +++ b/classes/zh_CN/class_font.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Font.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Font.xml. .. _class_Font: @@ -43,71 +43,71 @@ Font .. table:: :widths: auto - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`draw_char`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`draw_char_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_multiline_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`find_variation`\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_ascent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_char_size`\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_descent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_count`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_font_name`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_font_stretch`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`FontStyle`\] | :ref:`get_font_style`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_font_style_name`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_font_weight`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_height`\ (\ font_size\: :ref:`int` = 16\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_multiline_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_opentype_features`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_ot_name_strings`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`RID`\] | :ref:`get_rids`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_spacing`\ (\ spacing\: :ref:`SpacingType`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_supported_chars`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_supported_feature_list`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_supported_variation_list`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_underline_position`\ (\ font_size\: :ref:`int` = 16\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_underline_thickness`\ (\ font_size\: :ref:`int` = 16\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_char`\ (\ char\: :ref:`int`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_language_supported`\ (\ language\: :ref:`String`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_script_supported`\ (\ script\: :ref:`String`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cache_capacity`\ (\ single_line\: :ref:`int`, multi_line\: :ref:`int`\ ) | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`draw_char`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`draw_char_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`find_variation`\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_ascent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_char_size`\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_descent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_count`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_font_name`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_font_stretch`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`get_font_style`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_font_style_name`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_font_weight`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_height`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_multiline_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_opentype_features`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_ot_name_strings`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`get_rids`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_spacing`\ (\ spacing\: :ref:`SpacingType`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_supported_chars`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_supported_feature_list`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_supported_variation_list`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_underline_position`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_underline_thickness`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_char`\ (\ char\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_language_supported`\ (\ language\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_script_supported`\ (\ script\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_capacity`\ (\ single_line\: :ref:`int`, multi_line\: :ref:`int`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -146,9 +146,9 @@ Font .. rst-class:: classref-method -:ref:`float` **draw_char**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +:ref:`float` **draw_char**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用该字体将单个 Unicode 字符 ``char`` 绘制在画布项目中的给定的位置，颜色为 ``modulate``\ 。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用该字体将单个 Unicode 字符 ``char`` 绘制在画布项目中的给定的位置，颜色为 ``modulate``\ 。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 \ **注意：**\ 请勿使用这个方法进行逐字符的绘制，请改用 :ref:`draw_string()` 或 :ref:`TextLine`\ 。 @@ -160,9 +160,9 @@ Font .. rst-class:: classref-method -:ref:`float` **draw_char_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +:ref:`float` **draw_char_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用该字体将单个 Unicode 字符 ``char`` 的轮廓绘制在画布项目中的给定的位置，颜色为 ``modulate``\ 。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用该字体将单个 Unicode 字符 ``char`` 的轮廓绘制在画布项目中的给定的位置，颜色为 ``modulate``\ 。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 \ **注意：**\ 请勿使用这个方法进行逐字符的绘制，请改用 :ref:`draw_string()` 或 :ref:`TextLine`\ 。 @@ -174,9 +174,9 @@ Font .. rst-class:: classref-method -|void| **draw_multiline_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_multiline_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用 ``brk_flags`` 指定的规则对 ``text`` 进行断行，并使用该字体将其绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用 ``brk_flags`` 指定的规则对 ``text`` 进行断行，并使用该字体将其绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 另见 :ref:`CanvasItem.draw_multiline_string()`\ 。 @@ -188,9 +188,9 @@ Font .. rst-class:: classref-method -|void| **draw_multiline_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_multiline_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用 ``brk_flags`` 指定的规则对 ``text`` 进行断行，并使用该字体将其轮廓绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用 ``brk_flags`` 指定的规则对 ``text`` 进行断行，并使用该字体将其轮廓绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 另见 :ref:`CanvasItem.draw_multiline_string_outline()`\ 。 @@ -202,9 +202,9 @@ Font .. rst-class:: classref-method -|void| **draw_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用该字体将 ``text`` 绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用该字体将 ``text`` 绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 另见 :ref:`CanvasItem.draw_string()`\ 。 @@ -216,9 +216,9 @@ Font .. rst-class:: classref-method -|void| **draw_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` +|void| **draw_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -使用该字体将 ``text`` 的轮廓绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。 +使用该字体将 ``text`` 的轮廓绘制在画布项目中的给定位置，颜色为 ``modulate``\ ，也可以指定裁剪宽度并进行水平对齐。\ ``pos`` 指定的是基线位置而不是顶部。如果要按顶部位置绘制，则必须在 Y 轴中加入\ *升部*\ 。如果 ``oversampling`` 大于零，则会将其用作字体过采样系统，否则会使用视口的过采样设置。 另见 :ref:`CanvasItem.draw_string()`\ 。 @@ -322,7 +322,7 @@ Font |bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) |const| :ref:`🔗` -返回字体样式标志，见 :ref:`FontStyle`\ 。 +返回字体样式标志。 .. rst-class:: classref-item-separator @@ -422,7 +422,7 @@ Font :ref:`int` **get_spacing**\ (\ spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` -返回给定 ``type`` 的间距（请参阅 :ref:`SpacingType`\ ）。 +返回间隔类型 ``spacing`` 的间距。 .. rst-class:: classref-item-separator @@ -587,6 +587,7 @@ Font 为 ``draw_*`` 方法设置 LRU 缓存容量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_fontfile.rst b/classes/zh_CN/class_fontfile.rst index 8b59b2e3a6..e67cfc9db0 100644 --- a/classes/zh_CN/class_fontfile.rst +++ b/classes/zh_CN/class_fontfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FontFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FontFile.xml. .. _class_FontFile: @@ -100,6 +100,8 @@ FontFile +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`keep_rounding_remainders` | ``true`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``16`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -417,7 +419,7 @@ FontFile - |void| **set_font_style**\ (\ value\: |bitfield|\[:ref:`FontStyle`\]\ ) - |bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) -字体样式标志，见 :ref:`FontStyle`\ 。 +字体样式标志。 .. rst-class:: classref-item-separator @@ -508,6 +510,23 @@ FontFile ---- +.. _class_FontFile_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_modulate_color_glyphs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_modulate_color_glyphs**\ (\ ) + +如果设为 ``true``\ ，则绘制彩色字形时会应用颜色调制，否则只会对灰度字形应用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_FontFile_property_msdf_pixel_range: .. rst-class:: classref-property @@ -591,7 +610,7 @@ FontFile - |void| **set_oversampling**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_oversampling**\ (\ ) -字体过采样系数。如果设置为 ``0.0`` ，则使用全局过采样系数。仅由动态字体使用（MSDF 字体忽略过采样）。 +如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。 .. rst-class:: classref-item-separator @@ -814,7 +833,7 @@ FontFile :ref:`int` **get_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` -返回 ``spacing`` 的间距（见 :ref:`SpacingType`\ ），单位为像素（与字体大小无关）。 +返回 ``spacing`` 的间距，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -1292,7 +1311,7 @@ FontFile |void| **set_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` -将 ``spacing`` 的间距（见 :ref:`SpacingType`\ ）设置为 ``value``\ ，单位为像素（与字体大小无关）。 +将 ``spacing`` 的间距设置为 ``value``\ ，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -1453,6 +1472,7 @@ FontFile 为指定的字体缓存条目设置变体坐标。有关详细信息，请参阅 :ref:`Font.get_supported_variation_list()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_fontvariation.rst b/classes/zh_CN/class_fontvariation.rst index be1675071d..0fc29fc846 100644 --- a/classes/zh_CN/class_fontvariation.rst +++ b/classes/zh_CN/class_fontvariation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FontVariation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FontVariation.xml. .. _class_FontVariation: @@ -312,9 +312,10 @@ FontVariation |void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` -将 ``spacing`` 的间距（见 :ref:`SpacingType`\ ）设置为 ``value``\ ，单位为像素（与字体大小无关）。 +将 ``spacing`` 的间距设置为 ``value``\ ，单位为像素（与字体大小无关）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_framebuffercacherd.rst b/classes/zh_CN/class_framebuffercacherd.rst index b9eadd97de..951a3129e2 100644 --- a/classes/zh_CN/class_framebuffercacherd.rst +++ b/classes/zh_CN/class_framebuffercacherd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/FramebufferCacheRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FramebufferCacheRD.xml. .. _class_FramebufferCacheRD: @@ -51,6 +51,7 @@ FramebufferCacheRD 创建或获取缓存的帧缓冲区。\ ``textures`` 列出访问的纹理。\ ``passes`` 定义子通道和纹理分配，如果留空，则会创建单个通道并根据其使用标志分配纹理。\ ``views`` 定义渲染时使用的视图数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gdextension.rst b/classes/zh_CN/class_gdextension.rst index fdb51fabb2..3dac06c979 100644 --- a/classes/zh_CN/class_gdextension.rst +++ b/classes/zh_CN/class_gdextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GDExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GDExtension.xml. .. _class_GDExtension: @@ -30,7 +30,7 @@ GDExtension 的原生库。 - :doc:`GDExtension 概述 <../tutorials/scripting/gdextension/what_is_gdextension>` -- :doc:`C++ 的 GDExtension 示例 <../tutorials/scripting/gdextension/gdextension_cpp_example>` +- :doc:`C++ 的 GDExtension 示例 <../tutorials/scripting/cpp/gdextension_cpp_example>` .. rst-class:: classref-reftable-group @@ -123,6 +123,7 @@ enum **InitializationLevel**: :ref:`🔗` 如果该扩展的库已被打开，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gdextensionmanager.rst b/classes/zh_CN/class_gdextensionmanager.rst index 55d03e39c8..2e772b922b 100644 --- a/classes/zh_CN/class_gdextensionmanager.rst +++ b/classes/zh_CN/class_gdextensionmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GDExtensionManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GDExtensionManager.xml. .. _class_GDExtensionManager: @@ -30,7 +30,7 @@ GDExtensionManager 能够加载、初始化、跟踪项目中所有可用的 :re - :doc:`GDExtension 概述 <../tutorials/scripting/gdextension/what_is_gdextension>` -- :doc:`C++ 的 GDExtension 示例 <../tutorials/scripting/gdextension/gdextension_cpp_example>` +- :doc:`C++ 的 GDExtension 示例 <../tutorials/scripting/cpp/gdextension_cpp_example>` .. rst-class:: classref-reftable-group @@ -234,6 +234,7 @@ enum **LoadStatus**: :ref:`🔗` 按文件路径卸载扩展。\ ``path`` 需要指向已经加载的 :ref:`GDExtension`\ ，否则该方法返回 :ref:`LOAD_STATUS_NOT_LOADED`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gdscript.rst b/classes/zh_CN/class_gdscript.rst index fb80a2b105..7246904161 100644 --- a/classes/zh_CN/class_gdscript.rst +++ b/classes/zh_CN/class_gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gdscript/doc_classes/GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/GDScript.xml. .. _class_GDScript: @@ -68,6 +68,7 @@ GDScript assert(instance.get_script() == MyClass) # 输出 true .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gdscriptsyntaxhighlighter.rst b/classes/zh_CN/class_gdscriptsyntaxhighlighter.rst index 8bbd89382a..b5717526e2 100644 --- a/classes/zh_CN/class_gdscriptsyntaxhighlighter.rst +++ b/classes/zh_CN/class_gdscriptsyntaxhighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gdscript/doc_classes/GDScriptSyntaxHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/GDScriptSyntaxHighlighter.xml. .. _class_GDScriptSyntaxHighlighter: @@ -19,7 +19,7 @@ GDScript 语法高亮器，能够在 :ref:`TextEdit` 和 :ref:`C 描述 ---- -**注意：**\ 这个类智能用作编辑器插件，因为存在对编辑器设置的依赖。 +**注意：**\ 这个类只能用于编辑器插件，因为存在对编辑器设置的依赖。 .. tabs:: @@ -39,6 +39,7 @@ GDScript 语法高亮器，能够在 :ref:`TextEdit` 和 :ref:`C .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_generic6dofjoint3d.rst b/classes/zh_CN/class_generic6dofjoint3d.rst index 409a8c34c0..a2a14ed369 100644 --- a/classes/zh_CN/class_generic6dofjoint3d.rst +++ b/classes/zh_CN/class_generic6dofjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Generic6DOFJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Generic6DOFJoint3D.xml. .. _class_Generic6DOFJoint3D: @@ -2189,6 +2189,7 @@ Y 轴运动的恢复量。越低，动量损失越大。 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_geometry2d.rst b/classes/zh_CN/class_geometry2d.rst index f3b2ffe0e1..c0bacfc881 100644 --- a/classes/zh_CN/class_geometry2d.rst +++ b/classes/zh_CN/class_geometry2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Geometry2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Geometry2D.xml. .. _class_Geometry2D: @@ -421,7 +421,7 @@ enum **PolyEndType**: :ref:`🔗` var from_a = Vector2.ZERO var dir_a = Vector2.RIGHT var from_b = Vector2.DOWN - + # 返回 Vector2(1, 0) Geometry2D.line_intersects_line(from_a, dir_a, from_b, Vector2(1, -1)) # 返回 Vector2(-1, 0) @@ -434,7 +434,7 @@ enum **PolyEndType**: :ref:`🔗` var fromA = Vector2.Zero; var dirA = Vector2.Right; var fromB = Vector2.Down; - + // 返回新的 Vector2(1, 0) Geometry2D.LineIntersectsLine(fromA, dirA, fromB, new Vector2(1, -1)); // 返回新的 Vector2(-1, 0) @@ -482,7 +482,7 @@ enum **PolyEndType**: :ref:`🔗` 按 ``delta`` 单位（像素）膨胀或缩小 ``polygon``\ 。如果 ``delta`` 为正，则使多边形向外增长。如果 ``delta`` 为负，则使多边形向内收缩。返回一个多边形数组，因为膨胀/收缩可能会产生多个离散的多边形。如果 ``delta`` 为负，且其绝对值大约超过多边形的最小边界矩形尺寸，则返回一个空数组。 -每个多边形的顶点将根据 ``join_type`` 决定进行舍入，参见 :ref:`PolyJoinType`\ 。 +每个多边形的顶点将根据 ``join_type`` 决定进行舍入。 该操作可能会产生一个外部多边形（边界）和内部多边形（孔），这可以通过调用 :ref:`is_polygon_clockwise()` 来区分。 @@ -519,9 +519,9 @@ enum **PolyEndType**: :ref:`🔗` 将 ``polyline`` 膨胀或缩小 ``delta`` 个单位（像素），以产生多边形。如果 ``delta`` 为正，则使折线向外增长。返回一组多边形，因为膨胀/收缩可能会产生多个离散的多边形。如果 ``delta`` 为负，则返回一个空数组。 -每个多边形的顶点将由 ``join_type`` 决定进行舍入，参见 :ref:`PolyJoinType`\ 。 +每个多边形的顶点将由 ``join_type`` 决定进行舍入。 -每个多边形的端点将由 ``end_type`` 决定进行舍入，参见 :ref:`PolyEndType`\ 。 +每个多边形的端点将由 ``end_type`` 决定进行舍入。 该操作可能会产生一个外多边形（边界）和一个内多边形（孔），这可以通过调用 :ref:`is_polygon_clockwise()` 来区分。 @@ -586,6 +586,7 @@ enum **PolyEndType**: :ref:`🔗` 对由 ``polygon`` 中的点指定的多边形进行三角化。 返回一个 :ref:`PackedInt32Array`\ ，其中每个三角形由 ``polygon`` 中的三个连续点的索引组成（即返回的数组将具有 ``n * 3`` 个元素，其中 ``n`` 是找到的三角形的数量）。输出三角形将始终为逆时针旋转，如果为顺时针旋转，则轮廓将翻转。如果三角化没有成功，则返回一个空的 :ref:`PackedInt32Array`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_geometry3d.rst b/classes/zh_CN/class_geometry3d.rst index 993f04b67d..4c8f6bd27c 100644 --- a/classes/zh_CN/class_geometry3d.rst +++ b/classes/zh_CN/class_geometry3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Geometry3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Geometry3D.xml. .. _class_Geometry3D: @@ -249,6 +249,7 @@ Geometry3D 对 3D 空间中由离散的 ``points`` 集指定的区域进行四面体化，确保没有点位于任何生成的四面体的外接球内。该方法返回一个 :ref:`PackedInt32Array`\ ，其中每个四面体由 ``points`` 中的四个连续点的索引组成（即返回的数组将具有 ``n * 4`` 个元素，其中 ``n`` 是找到的四面体的数量）。如果四面体化没有成功，则返回一个空的 :ref:`PackedInt32Array`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_geometryinstance3d.rst b/classes/zh_CN/class_geometryinstance3d.rst index b96491632b..c84cc83f98 100644 --- a/classes/zh_CN/class_geometryinstance3d.rst +++ b/classes/zh_CN/class_geometryinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GeometryInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GeometryInstance3D.xml. .. _class_GeometryInstance3D: @@ -291,7 +291,7 @@ enum **VisibilityRangeFadeMode**: :ref:`🔗`\ ) - :ref:`ShadowCastingSetting` **get_cast_shadows_setting**\ (\ ) -选择的阴影投射标志。可能的取值见 :ref:`ShadowCastingSetting`\ 。 +所选的阴影投射标志。 .. rst-class:: classref-item-separator @@ -570,7 +570,7 @@ GeometryInstance3D 将被隐藏的距离，同时考虑 :ref:`visibility_range_e - |void| **set_visibility_range_fade_mode**\ (\ value\: :ref:`VisibilityRangeFadeMode`\ ) - :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode**\ (\ ) -控制在接近可见范围的限制时，哪些实例将被淡化。有关可能的值，请参阅 :ref:`VisibilityRangeFadeMode`\ 。 +控制在接近可见范围的限制时，哪些实例将被淡化。 .. rst-class:: classref-section-separator @@ -608,6 +608,7 @@ GeometryInstance3D 将被隐藏的距离，同时考虑 :ref:`visibility_range_e \ **注意：**\ 逐实例着色器 uniform 仅在 Spatial 和 CanvasItem 着色器中可用，在 Fog、Sky、Particles 着色器中不可用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfaccessor.rst b/classes/zh_CN/class_gltfaccessor.rst index 1ab2e819dd..fbcaae3515 100644 --- a/classes/zh_CN/class_gltfaccessor.rst +++ b/classes/zh_CN/class_gltfaccessor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFAccessor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFAccessor.xml. .. _class_GLTFAccessor: @@ -40,37 +40,37 @@ GLTFAccessor 是一种表示 glTF 访问器 ``"accessors"`` 的数据结构， .. table:: :widths: auto - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`GLTFAccessorType` | :ref:`accessor_type` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`buffer_view` | ``-1`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`byte_offset` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`component_type` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`count` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`PackedFloat64Array` | :ref:`max` | ``PackedFloat64Array()`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`PackedFloat64Array` | :ref:`min` | ``PackedFloat64Array()`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`normalized` | ``false`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_count` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_indices_buffer_view` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_indices_byte_offset` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_indices_component_type` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_values_buffer_view` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sparse_values_byte_offset` | ``0`` | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`type` | | - +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`GLTFAccessorType` | :ref:`accessor_type` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`buffer_view` | ``-1`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`byte_offset` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`GLTFComponentType` | :ref:`component_type` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`count` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`PackedFloat64Array` | :ref:`max` | ``PackedFloat64Array()`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`PackedFloat64Array` | :ref:`min` | ``PackedFloat64Array()`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`normalized` | ``false`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sparse_count` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sparse_indices_buffer_view` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sparse_indices_byte_offset` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`GLTFComponentType` | :ref:`sparse_indices_component_type` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sparse_values_buffer_view` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sparse_values_byte_offset` | ``0`` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`type` | | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-section-separator @@ -269,7 +269,7 @@ enum **GLTFComponentType**: :ref:`🔗` - |void| **set_accessor_type**\ (\ value\: :ref:`GLTFAccessorType`\ ) - :ref:`GLTFAccessorType` **get_accessor_type**\ (\ ) -glTF 访问器类型枚举。取值为 0 表示“SCALAR”、1 表示“VEC2”、2 表示“VEC3”、3 表示“VEC4”、4 表示“MAT2”、5 表示“MAT3”、6 表示“MAT4”。 +glTF 访问器类型枚举。 .. rst-class:: classref-item-separator @@ -313,12 +313,12 @@ glTF 访问器类型枚举。取值为 0 表示“SCALAR”、1 表示“VEC2” .. rst-class:: classref-property -:ref:`int` **component_type** = ``0`` :ref:`🔗` +:ref:`GLTFComponentType` **component_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget -- |void| **set_component_type**\ (\ value\: :ref:`int`\ ) -- :ref:`int` **get_component_type**\ (\ ) +- |void| **set_component_type**\ (\ value\: :ref:`GLTFComponentType`\ ) +- :ref:`GLTFComponentType` **get_component_type**\ (\ ) glTF 组件类型枚举。可能的取值见 :ref:`GLTFComponentType`\ 。核心 glTF 规格中，未通过 mesh.primitive.indices 引用的访问器不能使用 5125 或“UNSIGNED_INT”。 @@ -453,12 +453,12 @@ glTF 组件类型枚举。可能的取值见 :ref:`GLTFComponentType` **sparse_indices_component_type** = ``0`` :ref:`🔗` +:ref:`GLTFComponentType` **sparse_indices_component_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget -- |void| **set_sparse_indices_component_type**\ (\ value\: :ref:`int`\ ) -- :ref:`int` **get_sparse_indices_component_type**\ (\ ) +- |void| **set_sparse_indices_component_type**\ (\ value\: :ref:`GLTFComponentType`\ ) +- :ref:`GLTFComponentType` **get_sparse_indices_component_type**\ (\ ) 索引组件数据类型枚举。取值 5121 为“UNSIGNED_BYTE”、5123 为“UNSIGNED_SHORT”、5125 为“UNSIGNED_INT”。 @@ -513,9 +513,10 @@ glTF 组件类型枚举。可能的取值见 :ref:`GLTFComponentType` instead. -glTF 访问器类型枚举。请改用 :ref:`accessor_type`\ 。 +glTF 访问器类型 :ref:`int`\ 。取值为 ``0`` 表示“SCALAR”、\ ``1`` 表示“VEC2”、\ ``2`` 表示“VEC3”、\ ``3`` 表示“VEC4”、\ ``4`` 表示“MAT2”、\ ``5`` 表示“MAT3”、\ ``6`` 表示“MAT4”。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfanimation.rst b/classes/zh_CN/class_gltfanimation.rst index cb7e8eabe0..1efa1e9c35 100644 --- a/classes/zh_CN/class_gltfanimation.rst +++ b/classes/zh_CN/class_gltfanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFAnimation.xml. .. _class_GLTFAnimation: @@ -126,6 +126,7 @@ GLTFAnimation 第一个参数应该是 :ref:`GLTFDocumentExtension` 的名字（不必与 glTF 文件中的扩展名匹配），第二个参数可以是你想要的任何内容。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfbufferview.rst b/classes/zh_CN/class_gltfbufferview.rst index 1583c38e8b..66a2f0e48c 100644 --- a/classes/zh_CN/class_gltfbufferview.rst +++ b/classes/zh_CN/class_gltfbufferview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFBufferView.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFBufferView.xml. .. _class_GLTFBufferView: @@ -191,6 +191,7 @@ GLTFBufferView 是一种表示 glTF 缓冲区视图 ``bufferView`` 的数据结 从给定 :ref:`GLTFState` 中该缓冲区视图引用的缓冲区加载缓冲区视图数据。该方法尚不支持具有字节步幅的交错数据。数据以 :ref:`PackedByteArray` 形式返回。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfcamera.rst b/classes/zh_CN/class_gltfcamera.rst index 039078a75b..00248e4ab1 100644 --- a/classes/zh_CN/class_gltfcamera.rst +++ b/classes/zh_CN/class_gltfcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFCamera.xml. .. _class_GLTFCamera: @@ -40,17 +40,17 @@ GLTFCamera .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------+------------+ - | :ref:`float` | :ref:`depth_far` | ``4000.0`` | - +---------------------------+-----------------------------------------------------------+------------+ - | :ref:`float` | :ref:`depth_near` | ``0.05`` | - +---------------------------+-----------------------------------------------------------+------------+ - | :ref:`float` | :ref:`fov` | ``1.309`` | - +---------------------------+-----------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`perspective` | ``true`` | - +---------------------------+-----------------------------------------------------------+------------+ - | :ref:`float` | :ref:`size_mag` | ``0.5`` | - +---------------------------+-----------------------------------------------------------+------------+ + +---------------------------+-----------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`depth_far` | ``4000.0`` | + +---------------------------+-----------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`depth_near` | ``0.05`` | + +---------------------------+-----------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`fov` | ``1.3089969`` | + +---------------------------+-----------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`perspective` | ``true`` | + +---------------------------+-----------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`size_mag` | ``0.5`` | + +---------------------------+-----------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group @@ -117,7 +117,7 @@ GLTFCamera .. rst-class:: classref-property -:ref:`float` **fov** = ``1.309`` :ref:`🔗` +:ref:`float` **fov** = ``1.3089969`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,6 +214,7 @@ GLTFCamera 将这个 GLTFCamera 实例转换为 Godot :ref:`Camera3D` 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfdocument.rst b/classes/zh_CN/class_gltfdocument.rst index 48ed190653..5a9588b0c1 100644 --- a/classes/zh_CN/class_gltfdocument.rst +++ b/classes/zh_CN/class_gltfdocument.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFDocument.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocument.xml. .. _class_GLTFDocument: @@ -46,13 +46,19 @@ glTF 场景中的所有数据都存储在 :ref:`GLTFState` 类 .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`image_format` | ``"PNG"`` | - +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lossy_quality` | ``0.75`` | - +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`RootNodeMode` | :ref:`root_node_mode` | ``0`` | - +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`String` | :ref:`fallback_image_format` | ``"None"`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`fallback_image_quality` | ``0.25`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`String` | :ref:`image_format` | ``"PNG"`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`lossy_quality` | ``0.75`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`RootNodeMode` | :ref:`root_node_mode` | ``0`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ + | :ref:`VisibilityMode` | :ref:`visibility_mode` | ``0`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------------+------------+ .. rst-class:: classref-reftable-group @@ -125,6 +131,40 @@ enum **RootNodeMode**: :ref:`🔗` 将 Godot 场景的根节点视为 glTF 场景的名称，并将其所有子节点添加为 glTF 文件的根节点。这仅使用普通 glTF 功能。这避免了额外的根节点，但只会保留 Godot 场景根节点的名称，因为它不会被保存为节点。 +.. rst-class:: classref-item-separator + +---- + +.. _enum_GLTFDocument_VisibilityMode: + +.. rst-class:: classref-enumeration + +enum **VisibilityMode**: :ref:`🔗` + +.. _class_GLTFDocument_constant_VISIBILITY_MODE_INCLUDE_REQUIRED: + +.. rst-class:: classref-enumeration-constant + +:ref:`VisibilityMode` **VISIBILITY_MODE_INCLUDE_REQUIRED** = ``0`` + +如果场景中包含不可见节点，则会包含这些节点，使用 ``KHR_node_visibility`` 将它们标记为不可见，要求导入器将这些节点处理为不可见。缺点：如果导入器不支持 ``KHR_node_visibility`` 就无法导入该文件。 + +.. _class_GLTFDocument_constant_VISIBILITY_MODE_INCLUDE_OPTIONAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`VisibilityMode` **VISIBILITY_MODE_INCLUDE_OPTIONAL** = ``1`` + +如果场景中包含不可见节点，则会包含这些节点，使用 ``KHR_node_visibility`` 将它们标记为不可见，但并不对导入器施加任何要求。缺点：如果导入器不支持 ``KHR_node_visibility``\ ，本应不可见的对象就会可见。 + +.. _class_GLTFDocument_constant_VISIBILITY_MODE_EXCLUDE: + +.. rst-class:: classref-enumeration-constant + +:ref:`VisibilityMode` **VISIBILITY_MODE_EXCLUDE** = ``2`` + +如果场景中包含不可见节点，则导出的场景中不包含这些节点。与 Godot 4.4 及之前版本的行为一致。缺点：导出后的文件中不存在不可见节点。 + .. rst-class:: classref-section-separator ---- @@ -134,6 +174,42 @@ enum **RootNodeMode**: :ref:`🔗` 属性说明 -------- +.. _class_GLTFDocument_property_fallback_image_format: + +.. rst-class:: classref-property + +:ref:`String` **fallback_image_format** = ``"None"`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_fallback_image_format**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_fallback_image_format**\ (\ ) + +回退图像格式的用户友好名称，用于导出 glTF 文件，包括写入文件和写入字节数组。 + +该选项只能在“None”“PNG”“JPEG”中选择一个，只有在 :ref:`image_format` 不是“None”“PNG”“JPEG”三者之一时会用到。如果希望有多个扩展图像格式，可以使用 :ref:`GLTFDocumentExtension` 类来实现——此属性只适合在使用自定义图像格式时提供基本的 glTF 回退图像。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFDocument_property_fallback_image_quality: + +.. rst-class:: classref-property + +:ref:`float` **fallback_image_quality** = ``0.25`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_fallback_image_quality**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fallback_image_quality**\ (\ ) + +回退图像的质量，可能不存在。对于 PNG 文件而言，会根据这个系数缩小图像的宽高。对于 JPEG 文件而言，则是图像的失真质量。建议使用较低的值，因为在 glTF 文件中包含多个高质量图像会抵消使用更高效图像格式所带来的文件大小优势。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFDocument_property_image_format: .. rst-class:: classref-property @@ -147,7 +223,7 @@ enum **RootNodeMode**: :ref:`🔗` 导出图像格式的用户友好名称，用于导出 glTF 文件，包括写入文件和写入字节数组。 -默认情况下，Godot 允许以下选项：“无”“PNG”“JPEG”“无损 WebP”“有损 WebP”。可以使用 :ref:`GLTFDocumentExtension` 类添加对更多图像格式的支持。 +默认情况下，Godot 允许在“None”“PNG”“JPEG”“Lossless WebP”“Lossy WebP”中选择一个。可以在 :ref:`GLTFDocumentExtension` 类中添加对更多图像格式的支持。一个扩展类可以提供对特定格式的多种选项，甚至可以提供一个同时使用多种格式的选项。 .. rst-class:: classref-item-separator @@ -181,10 +257,27 @@ enum **RootNodeMode**: :ref:`🔗` - |void| **set_root_node_mode**\ (\ value\: :ref:`RootNodeMode`\ ) - :ref:`RootNodeMode` **get_root_node_mode**\ (\ ) -导出时如何处理根节点。详见 :ref:`RootNodeMode`\ 。默认和推荐值为 :ref:`ROOT_NODE_MODE_SINGLE_ROOT`\ 。 +导出时如何处理根节点。默认和推荐值为 :ref:`ROOT_NODE_MODE_SINGLE_ROOT`\ 。 \ **注意：**\ 无论 glTF 文件如何导出，导入时，根节点类型和名称都可以在场景导入设置选项卡中被覆盖。 +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFDocument_property_visibility_mode: + +.. rst-class:: classref-property + +:ref:`VisibilityMode` **visibility_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_visibility_mode**\ (\ value\: :ref:`VisibilityMode`\ ) +- :ref:`VisibilityMode` **get_visibility_mode**\ (\ ) + +导出时如何处理节点的可见性。如果所有节点都可见，则该设置不做任何事情。默认推荐值为 :ref:`VISIBILITY_MODE_INCLUDE_REQUIRED`\ ，使用 ``KHR_node_visibility`` 扩展。 + .. rst-class:: classref-section-separator ---- @@ -335,6 +428,7 @@ enum **RootNodeMode**: :ref:`🔗` \ **注意：**\ glTF 文件的扩展名决定了它是一个 .glb 二进制文件还是一个 .gltf 文本文件。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfdocumentextension.rst b/classes/zh_CN/class_gltfdocumentextension.rst index db882eddef..4e27edd063 100644 --- a/classes/zh_CN/class_gltfdocumentextension.rst +++ b/classes/zh_CN/class_gltfdocumentextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFDocumentExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocumentExtension.xml. .. _class_GLTFDocumentExtension: @@ -424,6 +424,7 @@ GLTFDocumentExtension 该方法可用于通过编辑 ``texture_json`` 设置该纹理 JSON 的扩展。还必须使用 :ref:`GLTFState.add_used_extension()` 将该扩展添加为使用的扩展，如果你不提供后备，请务必将 ``required`` 设置为 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfdocumentextensionconvertimportermesh.rst b/classes/zh_CN/class_gltfdocumentextensionconvertimportermesh.rst index b7fa4721ca..920b48f0d6 100644 --- a/classes/zh_CN/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/zh_CN/class_gltfdocumentextensionconvertimportermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFDocumentExtensionConvertImporterMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocumentExtensionConvertImporterMesh.xml. .. _class_GLTFDocumentExtensionConvertImporterMesh: @@ -24,6 +24,7 @@ GLTFDocumentExtensionConvertImporterMesh - :doc:`运行时文件加载与保存 <../tutorials/io/runtime_file_loading_and_saving>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltflight.rst b/classes/zh_CN/class_gltflight.rst index f32032738f..d9c97d7d1d 100644 --- a/classes/zh_CN/class_gltflight.rst +++ b/classes/zh_CN/class_gltflight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFLight.xml. .. _class_GLTFLight: @@ -47,7 +47,7 @@ GLTFLight +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`light_type` | ``""`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`outer_cone_angle` | ``0.785398`` | + | :ref:`float` | :ref:`outer_cone_angle` | ``0.7853982`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`range` | ``inf`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ @@ -94,7 +94,9 @@ GLTFLight - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) -灯的 :ref:`Color`\ 。默认为白色。黑色会导致灯光无效。 +灯光在线性空间中的 :ref:`Color`\ 。默认为白色。如果为黑色则灯光不会产生任何效果。 + +该值为线性，与 glTF 一致，但是导入创建 Godot :ref:`Light3D` 时会转换至非线性 sRGB 空间，将 Godot :ref:`Light3D` 导出为 glTF 时会转换至线性空间。 .. rst-class:: classref-item-separator @@ -157,7 +159,7 @@ GLTFLight .. rst-class:: classref-property -:ref:`float` **outer_cone_angle** = ``0.785398`` :ref:`🔗` +:ref:`float` **outer_cone_angle** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +185,7 @@ GLTFLight - |void| **set_range**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_range**\ (\ ) -灯光的范围，超过这个范围灯光无效。没有定义范围的 glTF 灯光的行为与无限范围的物理灯光一样。当创建 Godot 灯光时，范围限制在 4096。 +灯光的范围，超过这个范围灯光无效。没有定义范围的 glTF 灯光的行为与物理灯光一样（范围无限）。创建 Godot 灯光时，范围限制在 ``4096.0``\ 。 .. rst-class:: classref-section-separator @@ -267,6 +269,7 @@ GLTFLight 将这个 GLTFLight 实例转换为 Godot :ref:`Light3D` 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfmesh.rst b/classes/zh_CN/class_gltfmesh.rst index f3e59ca2be..d7a81d30b3 100644 --- a/classes/zh_CN/class_gltfmesh.rst +++ b/classes/zh_CN/class_gltfmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFMesh.xml. .. _class_GLTFMesh: @@ -169,6 +169,7 @@ Material 对象数组，代表网格所使用的材质。 第一个参数应该是 :ref:`GLTFDocumentExtension` 的名字（不必与 glTF 文件中的扩展名匹配），第二个参数可以是你想要的任何内容。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfnode.rst b/classes/zh_CN/class_gltfnode.rst index c991c51814..40dc5e64b6 100644 --- a/classes/zh_CN/class_gltfnode.rst +++ b/classes/zh_CN/class_gltfnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFNode.xml. .. _class_GLTFNode: @@ -65,6 +65,8 @@ glTF 节点通常存在于表示 glTF 文件中的所有数据的 :ref:`GLTFStat +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`skin` | ``-1`` | +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`visible` | ``true`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`xform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ @@ -106,7 +108,7 @@ glTF 节点通常存在于表示 glTF 文件中的所有数据的 :ref:`GLTFStat - |void| **set_camera**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_camera**\ (\ ) -如果该 glTF 节点是一个相机，则 :ref:`GLTFState` 中 :ref:`GLTFCamera` 的索引将描述该相机的属性。如果为 -1，则该节点不是相机。 +如果该 glTF 节点是一个相机，则 :ref:`GLTFState` 中 :ref:`GLTFCamera` 的索引将描述该相机的属性。如果为 ``-1``\ ，则该节点不是相机。 .. rst-class:: classref-item-separator @@ -301,6 +303,23 @@ glTF 节点通常存在于表示 glTF 文件中的所有数据的 :ref:`GLTFStat ---- +.. _class_GLTFNode_property_visible: + +.. rst-class:: classref-property + +:ref:`bool` **visible** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_visible**\ (\ ) + +如果为 ``true``\ ，则 GLTF 节点可见。如果 ``false``\ ，则 GLTF 节点不可见。这会被转换为 Godot 场景中的 :ref:`Node3D.visible` 属性，为 ``false`` 时会导出到 ``KHR_node_visibility``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFNode_property_xform: .. rst-class:: classref-property @@ -374,6 +393,7 @@ glTF 节点相对于其父节点的变换。由于通常首选位置、旋转和 第一个参数应该是 :ref:`GLTFDocumentExtension` 的名字（不必与 glTF 文件中的扩展名相匹配），第二个参数可以是任何你想要的东西。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfobjectmodelproperty.rst b/classes/zh_CN/class_gltfobjectmodelproperty.rst index 9fdd28c1f6..944eec4bcb 100644 --- a/classes/zh_CN/class_gltfobjectmodelproperty.rst +++ b/classes/zh_CN/class_gltfobjectmodelproperty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFObjectModelProperty.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFObjectModelProperty.xml. .. _class_GLTFObjectModelProperty: @@ -271,7 +271,7 @@ enum **GLTFObjectModelType**: :ref:`🔗`\ ) - :ref:`GLTFObjectModelType` **get_object_model_type**\ (\ ) -根据对象模型定义，存储在 glTF 文件中的数据类型。这是可用访问器类型的超集，决定了访问器类型。可能的取值见 :ref:`GLTFObjectModelType`\ 。 +根据对象模型定义，存储在 glTF 文件中的数据类型。这是可用访问器类型的超集，决定了访问器类型。 .. rst-class:: classref-item-separator @@ -368,6 +368,7 @@ enum **GLTFObjectModelType**: :ref:`🔗` 和 :ref:`object_model_type` 属性。这是用来同时设置这两个属性的便捷方法，因为两者几乎都是一起确定的。该方法只应该调用一次。再次使用相同的值调用没有效果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfphysicsbody.rst b/classes/zh_CN/class_gltfphysicsbody.rst index 5a18f1140b..de46d5a9ba 100644 --- a/classes/zh_CN/class_gltfphysicsbody.rst +++ b/classes/zh_CN/class_gltfphysicsbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFPhysicsBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFPhysicsBody.xml. .. _class_GLTFPhysicsBody: @@ -111,7 +111,11 @@ GLTFPhysicsBody - |void| **set_body_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_body_type**\ (\ ) -该物体的类型。导入时，控制 Godot 应该生成哪种类型的 :ref:`CollisionObject3D` 节点。有效值有 “static”、“animatable”、“character”、“rigid”、“vehicle”、“trigger”。导出时，这将被压缩为 “static”、“kinematic” 或 “dynamic” 运动类型之一，或为 “trigger” 属性。 +物体的类型。 + +导入时，控制 Godot 应该生成哪种类型的 :ref:`CollisionObject3D` 节点。有效值有 ``"static"``\ 、\ ``"animatable"``\ 、\ ``"character"``\ 、\ ``"rigid"``\ 、\ ``"vehicle"``\ 、\ ``"trigger"``\ 。 + +导出时，会合并为 ``"static"``\ 、\ ``"kinematic"`` 或 ``"dynamic"`` 运动类型，或 ``"trigger"`` 属性。 .. rst-class:: classref-item-separator @@ -275,6 +279,7 @@ GLTFPhysicsBody 将这个 GLTFPhysicsBody 实例转换为 Godot :ref:`CollisionObject3D` 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfphysicsshape.rst b/classes/zh_CN/class_gltfphysicsshape.rst index 74b8e824eb..3048962f25 100644 --- a/classes/zh_CN/class_gltfphysicsshape.rst +++ b/classes/zh_CN/class_gltfphysicsshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFPhysicsShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFPhysicsShape.xml. .. _class_GLTFPhysicsShape: @@ -98,7 +98,7 @@ GLTFPhysicsShape - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -形状的高度，单位为米。仅在形状类型为“capsule”或“cylinder”时使用。这个值不能为负数，并且对于“capsule”而言应当至少是半径的两倍。 +形状的高度，单位为米。仅在形状类型为 ``"capsule"`` 或 ``"cylinder"`` 时使用。这个值不能为负数，并且对于 ``"capsule"`` 而言应当至少是半径的两倍。 .. rst-class:: classref-item-separator @@ -115,7 +115,7 @@ GLTFPhysicsShape - |void| **set_importer_mesh**\ (\ value\: :ref:`ImporterMesh`\ ) - :ref:`ImporterMesh` **get_importer_mesh**\ (\ ) -形状的 :ref:`ImporterMesh` 资源。仅在形状类型为“hull”（凸包）和“trimesh”（凹三角网格）时使用。 +形状的 :ref:`ImporterMesh` 资源。仅在形状类型为 ``"hull"``\ （凸包）和 ``"trimesh"``\ （凹三角网格）时使用。 .. rst-class:: classref-item-separator @@ -132,7 +132,7 @@ GLTFPhysicsShape - |void| **set_is_trigger**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_trigger**\ (\ ) -如果为 ``true``\ ，则表示这个形状是触发器。对于 Godot 而言，这意味着该形状应当是 Area3D 节点的子节点。 +如果为 ``true``\ ，则表示这个形状是触发器。对于 Godot 而言，这意味着该形状应当是 :ref:`Area3D` 节点的子节点。 这是 :ref:`to_node()` 方法中唯一没有用到的变量，应该单独用来确定要将生成的节点添加到哪个节点之下。 @@ -151,7 +151,7 @@ GLTFPhysicsShape - |void| **set_mesh_index**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_mesh_index**\ (\ ) -形状网格在 glTF 文件中的索引。仅在形状类型为“hull”（凸包）和“trimesh”（凹三角网格）时使用。 +形状网格在 glTF 文件中的索引。仅在形状类型为 ``"hull"``\ （凸包）和 ``"trimesh"``\ （凹三角网格）时使用。 .. rst-class:: classref-item-separator @@ -168,7 +168,7 @@ GLTFPhysicsShape - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) -形状的半径，单位为米。仅在形状类型为“capsule”“cylinder”或“sphere”时使用。这个值不应为负数。 +形状的半径，单位为米。仅在形状类型为 ``"capsule"``\ 、\ ``"cylinder"`` 或 ``"sphere"`` 时使用。这个值不应为负数。 .. rst-class:: classref-item-separator @@ -185,7 +185,7 @@ GLTFPhysicsShape - |void| **set_shape_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_shape_type**\ (\ ) -这个形状所代表的形状类型。有效取值有“box”“capsule”“cylinder”“sphere”“hull”以及“trimesh”。 +这个形状所代表的形状类型。有效取值有 ``"box"``\ 、\ ``"capsule"``\ 、\ ``"cylinder"``\ 、\ ``"sphere"``\ 、\ ``"hull"``\ 、\ ``"trimesh"``\ 。 .. rst-class:: classref-item-separator @@ -202,7 +202,7 @@ GLTFPhysicsShape - |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_size**\ (\ ) -形状的大小，单位为米。仅在碰撞体类型为“box”时使用，代表盒子的“直径”。这个值不应为负数。 +形状的大小，单位为米。仅在碰撞体类型为 ``"box"`` 时使用，代表盒子的 ``"diameter"``\ （直径）。这个值不应为负数。 .. rst-class:: classref-section-separator @@ -282,6 +282,7 @@ GLTFPhysicsShape 将这个 GLTFPhysicsShape 实例转换为 Godot :ref:`Shape3D` 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfskeleton.rst b/classes/zh_CN/class_gltfskeleton.rst index 0cf16d9e52..be6d3b5bb7 100644 --- a/classes/zh_CN/class_gltfskeleton.rst +++ b/classes/zh_CN/class_gltfskeleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFSkeleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSkeleton.xml. .. _class_GLTFSkeleton: @@ -208,6 +208,7 @@ GLTFSkeleton 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfskin.rst b/classes/zh_CN/class_gltfskin.rst index e0b6d80daf..2bb7512994 100644 --- a/classes/zh_CN/class_gltfskin.rst +++ b/classes/zh_CN/class_gltfskin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFSkin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSkin.xml. .. _class_GLTFSkin: @@ -305,6 +305,7 @@ GLTFSkin 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfspecgloss.rst b/classes/zh_CN/class_gltfspecgloss.rst index 0d396a7fa7..1d05739221 100644 --- a/classes/zh_CN/class_gltfspecgloss.rst +++ b/classes/zh_CN/class_gltfspecgloss.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFSpecGloss.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSpecGloss.xml. .. _class_GLTFSpecGloss: @@ -141,6 +141,7 @@ KHR_materials_pbrSpecularGlossiness 是一个已归档的 glTF 扩展。这意 材质的镜面反射 RGB 颜色。不使用 Alpha 通道。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltfstate.rst b/classes/zh_CN/class_gltfstate.rst index d1bbaa942d..4fabfeee91 100644 --- a/classes/zh_CN/class_gltfstate.rst +++ b/classes/zh_CN/class_gltfstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFState.xml. .. _class_GLTFState: @@ -489,7 +489,7 @@ glTF 文件的根节点。通常一个 glTF 文件只有一个场景，因此只 :ref:`int` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) :ref:`🔗` -将给定的字节数组数据附加到缓冲区并为其创建一个 :ref:`GLTFBufferView`\ 。返回目标 :ref:`GLTFBufferView` 的索引。如果 ``deduplication`` 为 ``true``\ ，则将首先在缓冲区中搜索重复数据，否则将始终追加新字节。 +将字节数组数据 ``data`` 附加到缓冲区并为其创建一个 :ref:`GLTFBufferView`\ 。返回目标 :ref:`GLTFBufferView` 的索引。如果 ``deduplication`` 为 ``true``\ ，则会首先在缓冲区中搜索重复数据，否则会始终追加新字节。 .. rst-class:: classref-item-separator @@ -992,6 +992,7 @@ glTF 文件的根节点。通常一个 glTF 文件只有一个场景，因此只 设置该状态中的唯一节点名称。这用于导入过程和导出过程。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltftexture.rst b/classes/zh_CN/class_gltftexture.rst index fc7b0e851f..e1c0959d68 100644 --- a/classes/zh_CN/class_gltftexture.rst +++ b/classes/zh_CN/class_gltftexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFTexture.xml. .. _class_GLTFTexture: @@ -75,6 +75,7 @@ GLTFTexture 代表 glTF 文件中的纹理。 与该纹理关联的图像索引，见 :ref:`GLTFState.get_images()`\ 。如果为 -1，则该纹理未与图像相关联。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gltftexturesampler.rst b/classes/zh_CN/class_gltftexturesampler.rst index 046df34684..0afaf123e9 100644 --- a/classes/zh_CN/class_gltftexturesampler.rst +++ b/classes/zh_CN/class_gltftexturesampler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gltf/doc_classes/GLTFTextureSampler.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFTextureSampler.xml. .. _class_GLTFTextureSampler: @@ -120,6 +120,7 @@ GLTFTextureSampler 用于 T 轴（垂直）纹理坐标的环绕模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticles2d.rst b/classes/zh_CN/class_gpuparticles2d.rst index 1d2cd8e1a7..1609773a2c 100644 --- a/classes/zh_CN/class_gpuparticles2d.rst +++ b/classes/zh_CN/class_gpuparticles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticles2D.xml. .. _class_GPUParticles2D: @@ -305,7 +305,7 @@ enum **EmitFlags**: :ref:`🔗` - |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) - :ref:`DrawOrder` **get_draw_order**\ (\ ) -粒子绘制顺序。使用 :ref:`DrawOrder` 的值。 +粒子绘制顺序。 .. rst-class:: classref-item-separator @@ -775,6 +775,7 @@ enum **EmitFlags**: :ref:`🔗` 如果 ``keep_seed`` 为 ``true``\ ，则会保留当前的随机数种子。适用于跳转播放。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticles3d.rst b/classes/zh_CN/class_gpuparticles3d.rst index c7c9811f47..5cb46a7435 100644 --- a/classes/zh_CN/class_gpuparticles3d.rst +++ b/classes/zh_CN/class_gpuparticles3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticles3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticles3D.xml. .. _class_GPUParticles3D: @@ -398,7 +398,7 @@ enum **TransformAlign**: :ref:`🔗` - |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) - :ref:`DrawOrder` **get_draw_order**\ (\ ) -粒子绘制顺序。使用 :ref:`DrawOrder` 值。 +粒子绘制顺序。 \ **注意：**\ :ref:`DRAW_ORDER_INDEX` 是支持 TAA 等效果的运动向量的唯一选项。如果粒子不透明，建议使用该绘制顺序来修复重影伪影。 @@ -966,6 +966,7 @@ enum **TransformAlign**: :ref:`🔗` 设置在索引 ``pass`` 处绘制的 :ref:`Mesh` 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlesattractor3d.rst b/classes/zh_CN/class_gpuparticlesattractor3d.rst index 09be396718..6fd9541285 100644 --- a/classes/zh_CN/class_gpuparticlesattractor3d.rst +++ b/classes/zh_CN/class_gpuparticlesattractor3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesAttractor3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractor3D.xml. .. _class_GPUParticlesAttractor3D: @@ -127,6 +127,7 @@ GPUParticlesAttractor3D 调整吸引器的强度。如果 :ref:`strength` 为负，则粒子将被反向推动。如果 :ref:`directionality` 为 ``0.0``\ ，则粒子将被推\ *离*\ 吸引器的原点；如果 :ref:`directionality` 大于 ``0.0``\ ，则粒子将被推向局部 +Z。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlesattractorbox3d.rst b/classes/zh_CN/class_gpuparticlesattractorbox3d.rst index e56f119840..71e88895f4 100644 --- a/classes/zh_CN/class_gpuparticlesattractorbox3d.rst +++ b/classes/zh_CN/class_gpuparticlesattractorbox3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesAttractorBox3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorBox3D.xml. .. _class_GPUParticlesAttractorBox3D: @@ -60,6 +60,7 @@ GPUParticlesAttractorBox3D 吸引器盒的尺寸，使用 3D 单位。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlesattractorsphere3d.rst b/classes/zh_CN/class_gpuparticlesattractorsphere3d.rst index ca76576531..e3711b9eea 100644 --- a/classes/zh_CN/class_gpuparticlesattractorsphere3d.rst +++ b/classes/zh_CN/class_gpuparticlesattractorsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesAttractorSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorSphere3D.xml. .. _class_GPUParticlesAttractorSphere3D: @@ -62,6 +62,7 @@ GPUParticlesAttractorSphere3D \ **注意：**\ 要得到拉伸椭圆形，可以对 **GPUParticlesAttractorSphere3D** 节点使用非统一缩放。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlesattractorvectorfield3d.rst b/classes/zh_CN/class_gpuparticlesattractorvectorfield3d.rst index 6b5376ff04..9a0688cb08 100644 --- a/classes/zh_CN/class_gpuparticlesattractorvectorfield3d.rst +++ b/classes/zh_CN/class_gpuparticlesattractorvectorfield3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesAttractorVectorField3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorVectorField3D.xml. .. _class_GPUParticlesAttractorVectorField3D: @@ -83,6 +83,7 @@ GPUParticlesAttractorVectorField3D \ **注意：**\ 为了获得更好的性能，3D 纹理的分辨率应该反映该吸引器的 :ref:`size`\ 。由于粒子吸引力通常是低频数据，因此可以将纹理保持在较低分辨率，例如 64×64×64。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlescollision3d.rst b/classes/zh_CN/class_gpuparticlescollision3d.rst index 87147cfea1..d435459813 100644 --- a/classes/zh_CN/class_gpuparticlescollision3d.rst +++ b/classes/zh_CN/class_gpuparticlescollision3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesCollision3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollision3D.xml. .. _class_GPUParticlesCollision3D: @@ -72,6 +72,7 @@ GPUParticlesCollision3D 通过在 :ref:`GPUParticles3D` 节点上设置 :ref:`ParticleProcessMaterial.collision_mode`\ ，也可以在每个进程材质的基础上禁用粒子碰撞。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlescollisionbox3d.rst b/classes/zh_CN/class_gpuparticlescollisionbox3d.rst index 3c1d419c0d..347a8437cc 100644 --- a/classes/zh_CN/class_gpuparticlescollisionbox3d.rst +++ b/classes/zh_CN/class_gpuparticlescollisionbox3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesCollisionBox3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionBox3D.xml. .. _class_GPUParticlesCollisionBox3D: @@ -62,6 +62,7 @@ GPUParticlesCollisionBox3D 碰撞框的范围，使用 3D 单位。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlescollisionheightfield3d.rst b/classes/zh_CN/class_gpuparticlescollisionheightfield3d.rst index 03327598c7..18f9de8ef7 100644 --- a/classes/zh_CN/class_gpuparticlescollisionheightfield3d.rst +++ b/classes/zh_CN/class_gpuparticlescollisionheightfield3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesCollisionHeightField3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionHeightField3D.xml. .. _class_GPUParticlesCollisionHeightField3D: @@ -286,6 +286,7 @@ enum **UpdateMode**: :ref:`🔗` 中的指定层，给定的 ``layer_number`` 在 ``1`` 到 ``20`` 之间，包括端点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlescollisionsdf3d.rst b/classes/zh_CN/class_gpuparticlescollisionsdf3d.rst index 0a7083cec2..8426c727d2 100644 --- a/classes/zh_CN/class_gpuparticlescollisionsdf3d.rst +++ b/classes/zh_CN/class_gpuparticlescollisionsdf3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesCollisionSDF3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionSDF3D.xml. .. _class_GPUParticlesCollisionSDF3D: @@ -256,6 +256,7 @@ enum **Resolution**: :ref:`🔗` 基于 ``value``\ ，启用或禁用 :ref:`bake_mask` 中的指定层，该层由给定的一个介于 1 和 32 之间的 ``layer_number`` 指定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gpuparticlescollisionsphere3d.rst b/classes/zh_CN/class_gpuparticlescollisionsphere3d.rst index e5aee05580..6ee3fb2eed 100644 --- a/classes/zh_CN/class_gpuparticlescollisionsphere3d.rst +++ b/classes/zh_CN/class_gpuparticlescollisionsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GPUParticlesCollisionSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionSphere3D.xml. .. _class_GPUParticlesCollisionSphere3D: @@ -62,6 +62,7 @@ GPUParticlesCollisionSphere3D 碰撞球的半径，以 3D 单位表示。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gradient.rst b/classes/zh_CN/class_gradient.rst index 6e96ab0510..0b455e0233 100644 --- a/classes/zh_CN/class_gradient.rst +++ b/classes/zh_CN/class_gradient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Gradient.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Gradient.xml. .. _class_Gradient: @@ -183,7 +183,7 @@ sRGB 色彩空间。 - |void| **set_interpolation_color_space**\ (\ value\: :ref:`ColorSpace`\ ) - :ref:`ColorSpace` **get_interpolation_color_space**\ (\ ) -用于在渐变点之间进行插值的色彩空间。不影响返回的颜色，返回的颜色始终在 sRGB 空间。可用的模式见 :ref:`ColorSpace`\ 。 +用于在渐变点之间进行插值的色彩空间。不影响返回的颜色，返回的颜色始终在 sRGB 空间。 \ **注意：**\ :ref:`interpolation_mode` 为 :ref:`GRADIENT_INTERPOLATE_CONSTANT` 时该设置无效。 @@ -202,7 +202,7 @@ sRGB 色彩空间。 - |void| **set_interpolation_mode**\ (\ value\: :ref:`InterpolationMode`\ ) - :ref:`InterpolationMode` **get_interpolation_mode**\ (\ ) -用于在渐变点之间进行插值的算法。可用的模式见 :ref:`InterpolationMode`\ 。 +用于在渐变点之间进行插值的算法。 .. rst-class:: classref-item-separator @@ -314,7 +314,7 @@ sRGB 色彩空间。 :ref:`Color` **sample**\ (\ offset\: :ref:`float`\ ) :ref:`🔗` -返回由偏移 ``offset`` 指定的插值颜色。 +返回偏移量 ``offset`` 插值后的颜色。\ ``offset`` 应当在 ``0.0`` 和 ``1.0`` 之间（含两端）。取值小于 ``0.0`` 返回的颜色与 ``0.0`` 相同，取值大于 ``1.0`` 返回的颜色与 ``1.0`` 相同。输入值不在该范围内时，请考虑对输入值使用 :ref:`@GlobalScope.remap()`\ ，将输出值设为 ``0.0`` 和 ``1.0``\ 。 .. rst-class:: classref-item-separator @@ -341,6 +341,7 @@ sRGB 色彩空间。 设置渐变色在索引 ``point`` 处的偏移。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gradienttexture1d.rst b/classes/zh_CN/class_gradienttexture1d.rst index 71c78aa808..3a946286cb 100644 --- a/classes/zh_CN/class_gradienttexture1d.rst +++ b/classes/zh_CN/class_gradienttexture1d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GradientTexture1D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GradientTexture1D.xml. .. _class_GradientTexture1D: @@ -96,6 +96,7 @@ GradientTexture1D 将从 :ref:`Gradient` 中获得的颜色样本的数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gradienttexture2d.rst b/classes/zh_CN/class_gradienttexture2d.rst index 5c65d615bb..1a086a5e3a 100644 --- a/classes/zh_CN/class_gradienttexture2d.rst +++ b/classes/zh_CN/class_gradienttexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GradientTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GradientTexture2D.xml. .. _class_GradientTexture2D: @@ -19,7 +19,9 @@ GradientTexture2D 描述 ---- -2D纹理，从一个 :ref:`Gradient` 中获取颜色来填充纹理数据。该纹理能够将颜色过渡转换为不同的图案，例如线性或径向渐变。渐变是针对每个像素单独采样的，因此它不一定代表渐变的精确副本（请参阅 :ref:`width` 和 :ref:`height`\ ）。另见 :ref:`GradientTexture1D`\ 、\ :ref:`CurveTexture` 和 :ref:`CurveXYZTexture`\ 。 +2D 纹理，从 :ref:`Gradient` 中获取颜色来填充纹理数据。该纹理能够将颜色过渡转换为不同的图案，例如线性渐变或径向渐变。填充纹理时，默认会从偏移 :ref:`fill_from` 的位置到偏移 :ref:`fill_to` 的位置对颜色进行插值，但渐变填充也可以在整张纹理上重复。 + +渐变是针对每个像素单独采样的，因此不一定代表渐变的精确副本（见 :ref:`width` 和 :ref:`height`\ ）。另见 :ref:`GradientTexture1D`\ 、\ :ref:`CurveTexture`\ 、\ :ref:`CurveXYZTexture`\ 。 .. rst-class:: classref-reftable-group @@ -142,7 +144,7 @@ enum **Repeat**: :ref:`🔗` - |void| **set_fill**\ (\ value\: :ref:`Fill`\ ) - :ref:`Fill` **get_fill**\ (\ ) -渐变填充类型，是 :ref:`Fill` 中的某个值。该纹理使用的是位于 :ref:`fill_from` 到 :ref:`fill_to` 偏移量的颜色，对它们进行插值填充。 +渐变的填充类型。 .. rst-class:: classref-item-separator @@ -227,7 +229,7 @@ enum **Repeat**: :ref:`🔗` - |void| **set_repeat**\ (\ value\: :ref:`Repeat`\ ) - :ref:`Repeat` **get_repeat**\ (\ ) -渐变重复类型，是 :ref:`Repeat` 中的某个值。该纹理默认从偏移量 :ref:`fill_from` 到 :ref:`fill_to` 填充，但渐变填充可以重复，从而覆盖整个纹理。 +渐变的重复类型。 .. rst-class:: classref-item-separator @@ -264,6 +266,7 @@ enum **Repeat**: :ref:`🔗` 从 :ref:`Gradient` 上获取的水平颜色采样数，也表示纹理的宽度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_graphedit.rst b/classes/zh_CN/class_graphedit.rst index 1b7ab21c83..99388598bb 100644 --- a/classes/zh_CN/class_graphedit.rst +++ b/classes/zh_CN/class_graphedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GraphEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphEdit.xml. .. _class_GraphEdit: @@ -82,11 +82,13 @@ GraphEdit +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`snapping_enabled` | ``true`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`type_names` | ``{}`` | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`zoom` | ``1.0`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`float` | :ref:`zoom_max` | ``2.0736`` | + | :ref:`float` | :ref:`zoom_max` | ``2.0736003`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`float` | :ref:`zoom_min` | ``0.232568`` | + | :ref:`float` | :ref:`zoom_min` | ``0.23256795`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`zoom_step` | ``1.2`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ @@ -136,6 +138,8 @@ GraphEdit +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_connection_line`\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connection_list_from_node`\ (\ node\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connections_intersecting_with_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GraphFrame` | :ref:`get_element_frame`\ (\ element\: :ref:`StringName`\ ) | @@ -206,6 +210,8 @@ GraphEdit +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ + | :ref:`StyleBox` | :ref:`panel_focus` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ .. rst-class:: classref-section-separator @@ -864,6 +870,23 @@ enum **GridPattern**: :ref:`🔗` ---- +.. _class_GraphEdit_property_type_names: + +.. rst-class:: classref-property + +:ref:`Dictionary` **type_names** = ``{}`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_type_names**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_type_names**\ (\ ) + +包含人类可读端口类型名称的 :ref:`Dictionary`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_property_zoom: .. rst-class:: classref-property @@ -885,7 +908,7 @@ enum **GridPattern**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **zoom_max** = ``2.0736`` :ref:`🔗` +:ref:`float` **zoom_max** = ``2.0736003`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -902,7 +925,7 @@ enum **GridPattern**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **zoom_min** = ``0.232568`` :ref:`🔗` +:ref:`float` **zoom_min** = ``0.23256795`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -967,7 +990,7 @@ enum **GridPattern**: :ref:`🔗` var port_size = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) var port_pos = in_node.get_position() + in_node.get_input_port_position(in_port) - port_size / 2 var rect = Rect2(port_pos, port_size) - + return rect.has_point(mouse_position) .. rst-class:: classref-item-separator @@ -990,7 +1013,7 @@ enum **GridPattern**: :ref:`🔗` var port_size = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) var port_pos = in_node.get_position() + in_node.get_output_port_position(in_port) - port_size / 2 var rect = Rect2(port_pos, port_size) - + return rect.has_point(mouse_position) .. rst-class:: classref-item-separator @@ -1229,6 +1252,51 @@ enum **GridPattern**: :ref:`🔗` ---- +.. _class_GraphEdit_method_get_connection_list_from_node: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **get_connection_list_from_node**\ (\ node\: :ref:`StringName`\ ) |const| :ref:`🔗` + +返回包含 ``node`` 节点所有连接的 :ref:`Array`\ 。 + +连接使用 :ref:`Dictionary` 表示，形式为： + +:: + + { + from_node: StringName, + from_port: int, + to_node: StringName, + to_port: int, + keep_alive: bool + } + +\ **示例：**\ 获取指定端口的所有连接： + +:: + + func get_connection_list_from_port(node, port): + var connections = get_connection_list_from_node(node) + var result = [] + for connection in connections: + var dict = {} + if connection["from_node"] == node and connection["from_port"] == port: + dict["node"] = connection["to_node"] + dict["port"] = connection["to_port"] + dict["type"] = "left" + result.push_back(dict) + elif connection["to_node"] == node and connection["to_port"] == port: + dict["node"] = connection["from_node"] + dict["port"] = connection["from_port"] + dict["type"] = "right" + result.push_back(dict) + return result + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_get_connections_intersecting_with_rect: .. rst-class:: classref-method @@ -1610,7 +1678,20 @@ enum **GridPattern**: :ref:`🔗` 绘制在栅格下方的背景。 +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphEdit_theme_style_panel_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel_focus** :ref:`🔗` + +当 **GraphEdit** 处于聚焦状态时使用的 :ref:`StyleBox`\ （使用辅助应用时）。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_graphelement.rst b/classes/zh_CN/class_graphelement.rst index e25a57af21..80faa9503b 100644 --- a/classes/zh_CN/class_graphelement.rst +++ b/classes/zh_CN/class_graphelement.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GraphElement.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphElement.xml. .. _class_GraphElement: @@ -268,6 +268,7 @@ GraphElement 的偏移量，相对于 :ref:`GraphEdit` 的滚 用于调整大小的图标，在 :ref:`resizable` 被启用时可见。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_graphframe.rst b/classes/zh_CN/class_graphframe.rst index 55912d3334..5d7b8a26af 100644 --- a/classes/zh_CN/class_graphframe.rst +++ b/classes/zh_CN/class_graphframe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GraphFrame.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphFrame.xml. .. _class_GraphFrame: @@ -290,6 +290,7 @@ GraphFrame 在 :ref:`GraphEdit` 内始终位于连接层和其 当 **GraphFrame** 被选中时，用于其标题栏的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_graphnode.rst b/classes/zh_CN/class_graphnode.rst index 6b4fc4550f..ed5ed40b79 100644 --- a/classes/zh_CN/class_graphnode.rst +++ b/classes/zh_CN/class_graphnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GraphNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphNode.xml. .. _class_GraphNode: @@ -37,11 +37,15 @@ GraphNode .. table:: :widths: auto + +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`bool` | :ref:`ignore_invalid_connection_type` | ``false`` | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | :ref:`slots_focus_mode` | ``3`` | + +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`String` | :ref:`title` | ``""`` | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ @@ -140,10 +144,14 @@ GraphNode +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel_focus` | | + +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel_selected` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`slot` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`slot_selected` | | + +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar_selected` | | @@ -158,13 +166,25 @@ GraphNode 信号 ---- +.. _class_GraphNode_signal_slot_sizes_changed: + +.. rst-class:: classref-signal + +**slot_sizes_changed**\ (\ ) :ref:`🔗` + +当任意插槽的大小可能已更改时发出。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_signal_slot_updated: .. rst-class:: classref-signal **slot_updated**\ (\ slot_index\: :ref:`int`\ ) :ref:`🔗` -当任何图形节点的插槽更新时发出。 +当任意图形节点的插槽更新时发出。 .. rst-class:: classref-section-separator @@ -192,6 +212,29 @@ GraphNode ---- +.. _class_GraphNode_property_slots_focus_mode: + +.. rst-class:: classref-property + +:ref:`FocusMode` **slots_focus_mode** = ``3`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_slots_focus_mode**\ (\ value\: :ref:`FocusMode`\ ) +- :ref:`FocusMode` **get_slots_focus_mode**\ (\ ) + +决定连接槽位的聚焦方法。 + +- 如果设为 :ref:`Control.FOCUS_CLICK`\ ，则只能使用鼠标创建连接。 + +- 如果设为 :ref:`Control.FOCUS_ALL`\ ，则槽位还可以使用 :ref:`ProjectSettings.input/ui_up` 和 :ref:`ProjectSettings.input/ui_down` 聚焦，使用 :ref:`ProjectSettings.input/ui_left` 和 :ref:`ProjectSettings.input/ui_right` 输入动作连接。 + +- 如果设为 :ref:`Control.FOCUS_ACCESSIBILITY`\ ，则只会在读屏软件活动时启用槽位输入动作。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_property_title: .. rst-class:: classref-property @@ -689,6 +732,18 @@ GraphNode ---- +.. _class_GraphNode_theme_style_panel_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel_focus** :ref:`🔗` + +当 **GraphNode** 处于聚焦状态时使用的 :ref:`StyleBox`\ （使用辅助应用时）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_theme_style_panel_selected: .. rst-class:: classref-themeproperty @@ -713,6 +768,18 @@ GraphNode ---- +.. _class_GraphNode_theme_style_slot_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **slot_selected** :ref:`🔗` + +当插槽处于聚焦状态时使用的 :ref:`StyleBox`\ （使用辅助应用时）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_theme_style_titlebar: .. rst-class:: classref-themeproperty @@ -734,6 +801,7 @@ GraphNode 当 **GraphNode** 被选中时，用于其标题栏的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gridcontainer.rst b/classes/zh_CN/class_gridcontainer.rst index 64198101ca..a66b2a6523 100644 --- a/classes/zh_CN/class_gridcontainer.rst +++ b/classes/zh_CN/class_gridcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GridContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GridContainer.xml. .. _class_GridContainer: @@ -110,6 +110,7 @@ GridContainer 子节点的垂直分隔量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gridmap.rst b/classes/zh_CN/class_gridmap.rst index ecda934ee0..14f7c0a270 100644 --- a/classes/zh_CN/class_gridmap.rst +++ b/classes/zh_CN/class_gridmap.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gridmap/doc_classes/GridMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gridmap/doc_classes/GridMap.xml. .. _class_GridMap: @@ -445,7 +445,9 @@ GridMap 作为静态体，意味着它们不会受到重力或是其他力的影 :ref:`Array` **get_bake_meshes**\ (\ ) :ref:`🔗` -返回当前 GridMap 中存在的所有烘焙网格的 :ref:`ArrayMesh` 和 :ref:`Transform3D` 引用的数组。 +返回当前 GridMap 中存在的已烘焙网格数组，元素为 :ref:`ArrayMesh` 和 :ref:`Transform3D`\ 。奇数索引为 :ref:`ArrayMesh`\ ，偶数索引为 :ref:`Transform3D`\ ，始终等于 :ref:`Transform3D.IDENTITY`\ 。 + +这个方法依赖于 :ref:`make_baked_meshes()` 的输出，如果尚未调用，则会使用 ``gen_lightmap_uv`` 为 ``true``\ 、\ ``lightmap_uv_texel_size`` 为 ``0.1`` 进行调用。 .. rst-class:: classref-item-separator @@ -529,7 +531,7 @@ GridMap 作为静态体，意味着它们不会受到重力或是其他力的影 :ref:`Array` **get_meshes**\ (\ ) |const| :ref:`🔗` -返回对应于栅格中非空单元格的 :ref:`Transform3D` 和 :ref:`Mesh` 引用的数组。变换在局部空间中指定。 +返回与栅格中非空单元格对应的数组，元素为 :ref:`Transform3D` 和 :ref:`Mesh` 引用。变换在局部空间中指定。奇数索引为 :ref:`Transform3D`\ ，偶数索引为 :ref:`Mesh`\ ，与前一个索引处的 :ref:`Transform3D` 对应。 .. rst-class:: classref-item-separator @@ -603,7 +605,9 @@ GridMap 作为静态体，意味着它们不会受到重力或是其他力的影 |void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool` = false, lightmap_uv_texel_size\: :ref:`float` = 0.1\ ) :ref:`🔗` -为指定的 :ref:`MeshLibrary` 中的所有网格烘焙光照贴图数据。 +生成一个烘焙网格，该网格表示分配给 :ref:`MeshLibrary` 的所有网格，会与 :ref:`LightmapGI` 一起使用。如果 ``gen_lightmap_uv`` 为 ``true``\ ，则将为当前在 **GridMap** 中使用的每个网格生成 UV2 数据。否则，只有已经存在 UV2 数据的网格才能使用烘焙光照贴图。在生成 UV2 时，\ ``lightmap_uv_texel_size`` 控制的是光照贴图的纹素密度，值越低得到的光照贴图越详细。如果 ``gen_lightmap_uv`` 为 ``false``\ ，则会忽略 ``lightmap_uv_texel_size``\ 。另见 :ref:`get_bake_meshes()`\ ，依赖本方法的输出。 + +\ **注意：**\ 调用该方法并不会对光照贴图进行烘焙，因为光照贴图是使用 :ref:`LightmapGI` 节点烘焙的。 .. rst-class:: classref-item-separator @@ -684,6 +688,7 @@ GridMap 作为静态体，意味着它们不会受到重力或是其他力的影 设置导航地图 :ref:`RID`\ ，用于 GridMap 节点单元格所烘焙的导航网格。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_gridmapeditorplugin.rst b/classes/zh_CN/class_gridmapeditorplugin.rst index f2935b493d..4e8977d500 100644 --- a/classes/zh_CN/class_gridmapeditorplugin.rst +++ b/classes/zh_CN/class_gridmapeditorplugin.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/gridmap/doc_classes/GridMapEditorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gridmap/doc_classes/GridMapEditorPlugin.xml. .. _class_GridMapEditorPlugin: @@ -156,6 +156,7 @@ GridMapEditorPlugin 提供对 :ref:`GridMap` 编辑器功能的 选中从 ``begin`` 到 ``end`` 范围内的单元格。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_groovejoint2d.rst b/classes/zh_CN/class_groovejoint2d.rst index f8e6f36a5b..39efcad7c3 100644 --- a/classes/zh_CN/class_groovejoint2d.rst +++ b/classes/zh_CN/class_groovejoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/GrooveJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GrooveJoint2D.xml. .. _class_GrooveJoint2D: @@ -75,6 +75,7 @@ GrooveJoint2D 沟槽的长度。沟槽是从关键原点沿着关节局部 Y 轴朝向 :ref:`length` 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hashingcontext.rst b/classes/zh_CN/class_hashingcontext.rst index 8e251171d8..525c6620c3 100644 --- a/classes/zh_CN/class_hashingcontext.rst +++ b/classes/zh_CN/class_hashingcontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HashingContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HashingContext.xml. .. _class_HashingContext: @@ -29,7 +29,7 @@ HashingContext 类提供了一个接口，用于在多次迭代中计算加密 .. code-tab:: gdscript const CHUNK_SIZE = 1024 - + func hash_file(path): # 检查文件是否存在。 if not FileAccess.file_exists(path): @@ -51,7 +51,7 @@ HashingContext 类提供了一个接口，用于在多次迭代中计算加密 .. code-tab:: csharp public const int ChunkSize = 1024; - + public void HashFile(string path) { // 检查文件是否存在。 @@ -175,6 +175,7 @@ enum **HashType**: :ref:`🔗` 使用给定的数据块 ``chunk`` 更新计算。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hboxcontainer.rst b/classes/zh_CN/class_hboxcontainer.rst index 27c9625aac..33bbdd9c0d 100644 --- a/classes/zh_CN/class_hboxcontainer.rst +++ b/classes/zh_CN/class_hboxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HBoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HBoxContainer.xml. .. _class_HBoxContainer: @@ -31,6 +31,7 @@ HBoxContainer - :doc:`使用容器 <../tutorials/ui/gui_containers>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_heightmapshape3d.rst b/classes/zh_CN/class_heightmapshape3d.rst index 9e7ea38bb6..90cef779d7 100644 --- a/classes/zh_CN/class_heightmapshape3d.rst +++ b/classes/zh_CN/class_heightmapshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HeightMapShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HeightMapShape3D.xml. .. _class_HeightMapShape3D: @@ -19,7 +19,7 @@ HeightMapShape3D 描述 ---- -3D 高度图形状，旨在用于物理。常用于为 :ref:`CollisionShape3D` 提供形状。可用于地形，但是有无法存储悬垂部分（如洞窟）的限制。\ **HeightMapShape3D** 中创建洞的方法是为所需区域分配极低的值。 +3D 高度图形状，旨在用于物理。常用于为 :ref:`CollisionShape3D` 提供形状。这种类型最常用于在固定宽度的栅格中放置顶点的地形。由于高度图的特性，它无法用于建模悬垂或洞穴，这些情况需要在相同的垂直位置上存在多个顶点。可以通过将所需顶点的高度赋值为 :ref:`@GDScript.NAN` 来在碰撞中打孔（GodotPhysics3D 和 Jolt Physics 中都支持）。然后就可以插入具有自己独立碰撞的网格，提供悬垂、洞穴等效果。 \ **性能：**\ 对 **HeightMapShape3D** 的碰撞检测比 :ref:`ConcavePolygonShape3D` 快，但与 :ref:`BoxShape3D` 等图元形状相比显著要慢。 @@ -33,10 +33,10 @@ HeightMapShape3D var heightmap_texture = ResourceLoader.load("res://heightmap_image.exr") var heightmap_image = heightmap_texture.get_image() heightmap_image.convert(Image.FORMAT_RF) - + var height_min = 0.0 var height_max = 10.0 - + update_map_data_from_image(heightmap_image, height_min, height_max) @@ -170,13 +170,16 @@ HeightMapShape3D |void| **update_map_data_from_image**\ (\ image\: :ref:`Image`, height_min\: :ref:`float`, height_max\: :ref:`float`\ ) :ref:`🔗` -使用从 :ref:`Image` 引用读取的数据更新 :ref:`map_data`\ 。自动调整高度图 :ref:`map_width` 和 :ref:`map_depth` 的大小以适应整个图像的宽度和高度。 +使用从 :ref:`Image` 引用读取的数据更新 :ref:`map_data`\ 。自动调整高度图的宽度 :ref:`map_width` 和高度 :ref:`map_depth`\ ，适应整个图像的宽度和高度。 图像格式需要为 :ref:`Image.FORMAT_RF`\ （32 位）、\ :ref:`Image.FORMAT_RH`\ （16 位）或 :ref:`Image.FORMAT_R8`\ （8 位）。 -每个图像像素都以浮点数形式读入，范围从 ``0.0``\ （黑色像素）到 ``1.0``\ （白色像素）。该范围值重新映射到 ``height_min`` 和 ``height_max`` 以形成最终高度值。 +每个图像像素都以浮点数形式读入，范围从 ``0.0``\ （黑色像素）到 ``1.0``\ （白色像素）。该范围值重新映射到最小高度 ``height_min`` 和最大高度 ``height_max``\ ，形成最终的高度值。 + +\ **注意：**\ 使用 16 位或 32 位数据的高度图时建议存储为 EXR 或 HDR 格式。使用 8 位高度数据或像 PNG 这样 Godot 会导入为 8 位的格式，将导致阶梯状地形。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hflowcontainer.rst b/classes/zh_CN/class_hflowcontainer.rst index 8689f88ebd..3111be27fe 100644 --- a/classes/zh_CN/class_hflowcontainer.rst +++ b/classes/zh_CN/class_hflowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HFlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HFlowContainer.xml. .. _class_HFlowContainer: @@ -29,6 +29,7 @@ HFlowContainer - :doc:`使用容器 <../tutorials/ui/gui_containers>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hingejoint3d.rst b/classes/zh_CN/class_hingejoint3d.rst index 3e7107a17e..dfb075e761 100644 --- a/classes/zh_CN/class_hingejoint3d.rst +++ b/classes/zh_CN/class_hingejoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HingeJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HingeJoint3D.xml. .. _class_HingeJoint3D: @@ -29,27 +29,27 @@ HingeJoint3D .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`angular_limit/bias` | ``0.3`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`bool` | :ref:`angular_limit/enable` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`angular_limit/lower` | ``-1.5708`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`angular_limit/relaxation` | ``1.0`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`angular_limit/softness` | ``0.9`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`angular_limit/upper` | ``1.5708`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`bool` | :ref:`motor/enable` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`motor/max_impulse` | ``1.0`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`motor/target_velocity` | ``1.0`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ - | :ref:`float` | :ref:`params/bias` | ``0.3`` | - +---------------------------+---------------------------------------------------------------------------------------+-------------+ + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`angular_limit/bias` | ``0.3`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`bool` | :ref:`angular_limit/enable` | ``false`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`angular_limit/lower` | ``-1.5707964`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`angular_limit/relaxation` | ``1.0`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`angular_limit/softness` | ``0.9`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`angular_limit/upper` | ``1.5707964`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`bool` | :ref:`motor/enable` | ``false`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`motor/max_impulse` | ``1.0`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`motor/target_velocity` | ``1.0`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ + | :ref:`float` | :ref:`params/bias` | ``0.3`` | + +---------------------------+---------------------------------------------------------------------------------------+----------------+ .. rst-class:: classref-reftable-group @@ -239,7 +239,7 @@ enum **Flag**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **angular_limit/lower** = ``-1.5708`` :ref:`🔗` +:ref:`float` **angular_limit/lower** = ``-1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ enum **Flag**: :ref:`🔗` .. rst-class:: classref-property -:ref:`float` **angular_limit/upper** = ``1.5708`` :ref:`🔗` +:ref:`float` **angular_limit/upper** = ``1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -421,6 +421,7 @@ enum **Flag**: :ref:`🔗` 设置指定参数的值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hmaccontext.rst b/classes/zh_CN/class_hmaccontext.rst index 64d09b2681..74ff1f0d18 100644 --- a/classes/zh_CN/class_hmaccontext.rst +++ b/classes/zh_CN/class_hmaccontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HMACContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HMACContext.xml. .. _class_HMACContext: @@ -28,7 +28,7 @@ HMACContext 类对于高级的 HMAC 用例非常有用，例如流式消息， extends Node var ctx = HMACContext.new() - + func _ready(): var key = "supersecret".to_utf8_buffer() var err = ctx.start(HashingContext.HASH_SHA256, key) @@ -41,17 +41,16 @@ HMACContext 类对于高级的 HMAC 用例非常有用，例如流式消息， assert(err == OK) var hmac = ctx.finish() print(hmac.hex_encode()) - .. code-tab:: csharp using Godot; using System.Diagnostics; - + public partial class MyNode : Node { private HmacContext _ctx = new HmacContext(); - + public override void _Ready() { byte[] key = "supersecret".ToUtf8Buffer(); @@ -128,6 +127,7 @@ HMACContext 类对于高级的 HMAC 用例非常有用，例如流式消息， 更新要进行 HMAC 处理的消息。在 :ref:`finish()` 被调用以将 ``data`` 追加到该消息之前，该函数可以多次被调用，但在 :ref:`start()` 被调用之前不能被调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hscrollbar.rst b/classes/zh_CN/class_hscrollbar.rst index ba2385572d..4a0c84ea05 100644 --- a/classes/zh_CN/class_hscrollbar.rst +++ b/classes/zh_CN/class_hscrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HScrollBar.xml. .. _class_HScrollBar: @@ -22,6 +22,7 @@ HScrollBar 水平滚动条，通常用于为超出控件可见宽度的内容进行导航。这是基于 :ref:`Range` 的控件，从左侧（最小）滚动到右侧（最大）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hseparator.rst b/classes/zh_CN/class_hseparator.rst index edeec300c5..6e4cfa1df6 100644 --- a/classes/zh_CN/class_hseparator.rst +++ b/classes/zh_CN/class_hseparator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HSeparator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSeparator.xml. .. _class_HSeparator: @@ -22,6 +22,7 @@ HSeparator 分隔其他\ **垂直**\ 排列的控件的水平线。\ **HSeparator** 只提供视觉上的分隔，通常用 :ref:`StyleBoxLine` 绘制。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hslider.rst b/classes/zh_CN/class_hslider.rst index 9a751946cb..8e1c788b17 100644 --- a/classes/zh_CN/class_hslider.rst +++ b/classes/zh_CN/class_hslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSlider.xml. .. _class_HSlider: @@ -22,6 +22,7 @@ HSlider 水平滑块，可用通过沿着水平轴移动抓取器来调整取值。这个控件继承自 :ref:`Range`\ ，从左（最小）到右（最大）滚动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_hsplitcontainer.rst b/classes/zh_CN/class_hsplitcontainer.rst index b098ae823f..2c6e880d7f 100644 --- a/classes/zh_CN/class_hsplitcontainer.rst +++ b/classes/zh_CN/class_hsplitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HSplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSplitContainer.xml. .. _class_HSplitContainer: @@ -29,6 +29,7 @@ HSplitContainer - :doc:`使用容器 <../tutorials/ui/gui_containers>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_httpclient.rst b/classes/zh_CN/class_httpclient.rst index a9fa40268e..846de3b825 100644 --- a/classes/zh_CN/class_httpclient.rst +++ b/classes/zh_CN/class_httpclient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/HTTPClient.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HTTPClient.xml. .. _class_HTTPClient: @@ -1012,7 +1012,7 @@ HTTP 状态码 ``511 Network Authentication Required``\ 。客户端需要身份 .. code-tab:: gdscript - var fields = {"username": "user", "password": "pass"} + var fields = { "username": "user", "password": "pass" } var query_string = http_client.query_string_from_dict(fields) # 返回 "username=user&password=pass" @@ -1031,7 +1031,7 @@ HTTP 状态码 ``511 Network Authentication Required``\ 。客户端需要身份 .. code-tab:: gdscript - var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]} + var fields = { "single": 123, "not_valued": null, "multiple": [22, 33, 44] } var query_string = http_client.query_string_from_dict(fields) # 返回 "single=123¬_valued&multiple=22&multiple=33&multiple=44" @@ -1070,11 +1070,11 @@ HTTP 状态码 ``511 Network Authentication Required``\ 。客户端需要身份 :ref:`Error` **request**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`String` = ""\ ) :ref:`🔗` -向连接的服务器发送请求。 +使用 ``method`` 方法向已连接的服务器发送 HTTP 请求。 URL 参数通常只是主机名后面的部分，所以对于 ``https://example.com/index.php`` 来说就是 ``/index.php``\ 。当向 HTTP 代理服务器发送请求时，它应该是一个绝对 URL。对于 :ref:`METHOD_OPTIONS` 请求，\ ``*`` 也是允许的。对于 :ref:`METHOD_CONNECT` 请求，它应该是权限组件 (``host:port``)。 -Headers 参数是 HTTP 请求的报头。有关可用的 HTTP 方法，请参阅 :ref:`Method`\ 。 +\ ``headers`` 是 HTTP 请求的报头。 要创建带有查询字符串的 POST 请求以推送到服务器，请执行以下操作： @@ -1083,7 +1083,7 @@ Headers 参数是 HTTP 请求的报头。有关可用的 HTTP 方法，请参阅 .. code-tab:: gdscript - var fields = {"username" : "user", "password" : "pass"} + var fields = { "username": "user", "password": "pass" } var query_string = http_client.query_string_from_dict(fields) var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())] var result = http_client.request(http_client.METHOD_POST, "/index.php", headers, query_string) @@ -1109,11 +1109,11 @@ Headers 参数是 HTTP 请求的报头。有关可用的 HTTP 方法，请参阅 :ref:`Error` **request_raw**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) :ref:`🔗` -向连接的服务器发送请求。 +使用 ``method`` 方法向已连接的服务器发送原始 HTTP 请求。 URL 参数通常只是主机名后面的部分，所以对于 ``https://example.com/index.php`` 来说就是 ``/index.php``\ 。当向 HTTP 代理服务器发送请求时，它应该是一个绝对 URL。对于 :ref:`METHOD_OPTIONS` 请求，\ ``*`` 也是允许的。对于 :ref:`METHOD_CONNECT` 请求，它应该是权限组件 (``host:port``)。 -Headers 参数是 HTTP 请求的报头。可用的 HTTP 方法见 :ref:`Method`\ 。 +\ ``headers`` 是 HTTP 请求的报头。 请求体是以字节数组的形式原样发送的，不会进行任何形式的编码。 @@ -1146,6 +1146,7 @@ Headers 参数是 HTTP 请求的报头。可用的 HTTP 方法见 :ref:`Method` **get_http_client_status**\ (\ ) |const| :ref:`🔗` -返回内部 :ref:`HTTPClient` 的当前状态。见 :ref:`Status`\ 。 +返回内部 :ref:`HTTPClient` 的当前状态。 .. rst-class:: classref-item-separator @@ -648,6 +648,7 @@ HTTPRequest 无法写入下载文件。 设置连接到 HTTPS 服务器时使用的 :ref:`TLSOptions`\ 。见 :ref:`TLSOptions.client()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_image.rst b/classes/zh_CN/class_image.rst index 1b5933d14d..98e6086e0a 100644 --- a/classes/zh_CN/class_image.rst +++ b/classes/zh_CN/class_image.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Image.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Image.xml. .. _class_Image: @@ -143,6 +143,8 @@ Image +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_bmp_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_dds_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_jpg_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | @@ -173,6 +175,10 @@ Image +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rotate_180`\ (\ ) | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_dds`\ (\ path\: :ref:`String`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_dds_to_buffer`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save_exr`\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`save_exr_to_buffer`\ (\ grayscale\: :ref:`bool` = false\ ) |const| | @@ -1010,7 +1016,7 @@ enum **ASTCFormat**: :ref:`🔗` |void| **convert**\ (\ format\: :ref:`Format`\ ) :ref:`🔗` -转换图像的格式。请参阅 :ref:`Format` 常量。 +将图像格式转换为 ``format``\ 。 .. rst-class:: classref-item-separator @@ -1036,7 +1042,7 @@ enum **ASTCFormat**: :ref:`🔗` **已弃用：** Use :ref:`create_empty()`. -创建一个给定大小和格式的空图像。请参阅 :ref:`Format` 常量。如果 ``use_mipmaps`` 为 ``true``\ ，则为该图像生成 Mipmaps。请参阅 :ref:`generate_mipmaps()`\ 。 +创建一个给定大小和格式的空图像。如果 ``use_mipmaps`` 为 ``true``\ ，则为该图像生成 Mipmap。 .. rst-class:: classref-item-separator @@ -1048,7 +1054,7 @@ enum **ASTCFormat**: :ref:`🔗` :ref:`Image` **create_empty**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| :ref:`🔗` -创建一个给定大小和格式的空图像。请参阅 :ref:`Format` 常量。如果 ``use_mipmaps`` 为 ``true``\ ，则为该图像生成 Mipmaps。请参阅 :ref:`generate_mipmaps()`\ 。 +创建一个给定大小和格式的空图像。如果 ``use_mipmaps`` 为 ``true``\ ，则为该图像生成 Mipmap。 .. rst-class:: classref-item-separator @@ -1060,7 +1066,7 @@ enum **ASTCFormat**: :ref:`🔗` :ref:`Image` **create_from_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` -创建一个给定大小和格式的新图像。请参阅 :ref:`Format` 常量。用给定的原始数据填充图像。如果 ``use_mipmaps`` 为 ``true``\ ，则从 ``data`` 为该图像加载 Mipmaps。请参阅 :ref:`generate_mipmaps()`\ 。 +创建一个给定大小和格式的新图像。用给定的原始数据填充图像。如果 ``use_mipmaps`` 为 ``true``\ ，则从 ``data`` 为该图像加载 Mipmap。见 :ref:`generate_mipmaps()`\ 。 .. rst-class:: classref-item-separator @@ -1110,7 +1116,7 @@ enum **ASTCFormat**: :ref:`🔗` :ref:`UsedChannels` **detect_used_channels**\ (\ source\: :ref:`CompressSource` = 0\ ) |const| :ref:`🔗` -返回某个 :ref:`UsedChannels` 常量，表示该图像所使用的颜色通道。如果为压缩图像，则必须使用 ``source`` 指定原始图像的属性。 +返回图像所使用的颜色通道。如果为压缩图像，则必须使用 ``source`` 指定原始图像。 .. rst-class:: classref-item-separator @@ -1220,7 +1226,7 @@ enum **ASTCFormat**: :ref:`🔗` :ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` -返回图像的格式。参阅 :ref:`Format` 常量。 +返回图像的格式。 .. rst-class:: classref-item-separator @@ -1430,6 +1436,20 @@ enum **ASTCFormat**: :ref:`🔗` ---- +.. _class_Image_method_load_dds_from_buffer: + +.. rst-class:: classref-method + +:ref:`Error` **load_dds_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` + +从 DDS 文件的二进制内容加载图像。 + +\ **注意：**\ 该方法仅在启用了 DDS 模块的引擎版本中可用。默认情况下，DDS 模块是启用的，但可以在构建时使用 ``module_dds_enabled=no`` SCons 选项禁用它。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_load_from_file: .. rst-class:: classref-method @@ -1622,6 +1642,34 @@ enum **ASTCFormat**: :ref:`🔗` ---- +.. _class_Image_method_save_dds: + +.. rst-class:: classref-method + +:ref:`Error` **save_dds**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` + +将图像以 DDS（DirectDraw Surface）文件的形式保存至 ``path`` 路径。DDS 是一种能够以 DXT1、DXT5、BC7 等压缩格式存储纹理的容器格式。如果编译 Godot 时未包含 DDS 模块，则该函数返回 :ref:`@GlobalScope.ERR_UNAVAILABLE`\ 。 + +\ **注意：**\ 某些构建会禁用 DDS 模块，这意味着当 :ref:`save_dds()` 从导出的项目中被调用时将返回 :ref:`@GlobalScope.ERR_UNAVAILABLE`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Image_method_save_dds_to_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **save_dds_to_buffer**\ (\ ) |const| :ref:`🔗` + +将图像以 DDS（DirectDraw Surface）文件的形式保存为字节数组。DDS 是一种能够以 DXT1、DXT5、BC7 等压缩格式存储纹理的容器格式。如果编译 Godot 时未包含 DDS 模块，则该函数返回空字节数组。 + +\ **注意：**\ 某些构建会禁用 DDS 模块，这意味着当 :ref:`save_dds_to_buffer()` 从导出的项目中被调用时将返回一个空字节数组。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_save_exr: .. rst-class:: classref-method @@ -1644,7 +1692,7 @@ enum **ASTCFormat**: :ref:`🔗` 将图像作为 EXR 文件保存到一个字节数组。如果 ``grayscale`` 为 ``true`` 并且图像只有一个通道，它将被明确地保存为单色而不是一个红色通道。如果 Godot 是在没有 TinyEXR 模块的情况下编译的，则该函数将返回一个空字节数组。 -\ **注意：**\ TinyEXR 模块在非编辑器构建中被禁用，这意味着当 :ref:`save_exr()` 从导出的项目中被调用时将返回一个空字节数组。 +\ **注意：**\ TinyEXR 模块在非编辑器构建中被禁用，这意味着当 :ref:`save_exr_to_buffer()` 从导出的项目中被调用时将返回一个空字节数组。 .. rst-class:: classref-item-separator @@ -1758,7 +1806,7 @@ enum **ASTCFormat**: :ref:`🔗` var img_width = 10 var img_height = 5 var img = Image.create(img_width, img_height, false, Image.FORMAT_RGBA8) - + img.set_pixel(1, 2, Color.RED) # 将 (1, 2) 处的颜色设置为红色。 .. code-tab:: csharp @@ -1766,7 +1814,7 @@ enum **ASTCFormat**: :ref:`🔗` int imgWidth = 10; int imgHeight = 5; var img = Image.Create(imgWidth, imgHeight, false, Image.Format.Rgba8); - + img.SetPixel(1, 2, Colors.Red); // 将 (1, 2) 处的颜色设置为红色。 @@ -1793,7 +1841,7 @@ enum **ASTCFormat**: :ref:`🔗` var img_width = 10 var img_height = 5 var img = Image.create(img_width, img_height, false, Image.FORMAT_RGBA8) - + img.set_pixelv(Vector2i(1, 2), Color.RED) # 将 (1, 2) 处的颜色设置为红色。 .. code-tab:: csharp @@ -1801,7 +1849,7 @@ enum **ASTCFormat**: :ref:`🔗` int imgWidth = 10; int imgHeight = 5; var img = Image.Create(imgWidth, imgHeight, false, Image.Format.Rgba8); - + img.SetPixelv(new Vector2I(1, 2), Colors.Red); // 将 (1, 2) 处的颜色设置为红色。 @@ -1833,6 +1881,7 @@ enum **ASTCFormat**: :ref:`🔗` 将原始数据从 sRGB 色彩空间转换至线性尺度。仅对格式为 :ref:`FORMAT_RGB8` 和 :ref:`FORMAT_RGBA8` 的图像有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_imageformatloader.rst b/classes/zh_CN/class_imageformatloader.rst index b3fcdc2945..570adc7896 100644 --- a/classes/zh_CN/class_imageformatloader.rst +++ b/classes/zh_CN/class_imageformatloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImageFormatLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageFormatLoader.xml. .. _class_ImageFormatLoader: @@ -75,6 +75,7 @@ flags **LoaderFlags**: :ref:`🔗` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_imageformatloaderextension.rst b/classes/zh_CN/class_imageformatloaderextension.rst index d5e9558812..ec60241578 100644 --- a/classes/zh_CN/class_imageformatloaderextension.rst +++ b/classes/zh_CN/class_imageformatloaderextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImageFormatLoaderExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageFormatLoaderExtension.xml. .. _class_ImageFormatLoaderExtension: @@ -95,6 +95,7 @@ ImageFormatLoaderExtension 从引擎中移除这个格式加载器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_imagetexture.rst b/classes/zh_CN/class_imagetexture.rst index 2f2a377e2c..37685b4b56 100644 --- a/classes/zh_CN/class_imagetexture.rst +++ b/classes/zh_CN/class_imagetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImageTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTexture.xml. .. _class_ImageTexture: @@ -115,7 +115,7 @@ ImageTexture :ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` -返回纹理的格式，\ :ref:`Format` 之一。 +返回该纹理的格式。 .. rst-class:: classref-item-separator @@ -160,6 +160,7 @@ ImageTexture 如果需要频繁更新纹理，请使用该方法而不是 :ref:`set_image()`\ ，这比每次为一个新纹理分配额外内存要快。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_imagetexture3d.rst b/classes/zh_CN/class_imagetexture3d.rst index ab755a48db..521bbdcb82 100644 --- a/classes/zh_CN/class_imagetexture3d.rst +++ b/classes/zh_CN/class_imagetexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImageTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTexture3D.xml. .. _class_ImageTexture3D: @@ -52,7 +52,7 @@ ImageTexture3D :ref:`Error` **create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, use_mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` -创建具有指定 ``width``\ 、\ ``height`` 和 ``depth`` 的 **ImageTexture3D**\ 。请参阅 :ref:`Format` 了解 ``format`` 选项。如果 ``use_mipmaps`` 为 ``true``\ ，则为该 **ImageTexture3D** 生成 Mipmaps。 +创建格式为 ``format``\ 、宽度为 ``width``\ 、高度为 ``height``\ 、色深为 ``depth`` 的 **ImageTexture3D**\ 。如果 ``use_mipmaps`` 为 ``true``\ ，则为该 **ImageTexture3D** 生成 Mipmap。 .. rst-class:: classref-item-separator @@ -67,6 +67,7 @@ ImageTexture3D 将纹理的现有数据替换为 ``data`` 中指定的图层。\ ``data`` 的大小必须与用于 :ref:`create()` 的参数一致。换句话说，不能通过调用 :ref:`update()` 来调整纹理的大小或改变其格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_imagetexturelayered.rst b/classes/zh_CN/class_imagetexturelayered.rst index 69cbeb828c..36a50bddc5 100644 --- a/classes/zh_CN/class_imagetexturelayered.rst +++ b/classes/zh_CN/class_imagetexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImageTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTextureLayered.xml. .. _class_ImageTextureLayered: @@ -70,19 +70,19 @@ ImageTextureLayered else: image.fill(Color.BLUE) images.push_back(image) - + # 创建并保存 2D 纹理数组。图像数组中必须至少有 1 个图像。 var texture_2d_array = Texture2DArray.new() texture_2d_array.create_from_images(images) ResourceSaver.save(texture_2d_array, "res://texture_2d_array.res", ResourceSaver.FLAG_COMPRESS) - + # 创建并保存立方体贴图。图像数组中图像的数量必须为 6。 # 立方体贴图图像的顺序为：X+、X-、Y+、Y-、Z+、Z- # （使用 Godot 的坐标系，因此 Y+ 是“上”、Z- 是“前”）。 var cubemap = Cubemap.new() cubemap.create_from_images(images) ResourceSaver.save(cubemap, "res://cubemap.res", ResourceSaver.FLAG_COMPRESS) - + # 创建并保存立方体贴图数组。图像数组中图像的数量必须为 6 的倍数。 # 每个立方体贴图图像的顺序为：X+、X-、Y+、Y-、Z+、Z- # （使用 Godot 的坐标系，因此 Y+ 是“上”、Z- 是“前”）。 @@ -109,6 +109,7 @@ ImageTextureLayered 更新是即时的：它与绘制同步。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_immediatemesh.rst b/classes/zh_CN/class_immediatemesh.rst index f1d925ba0a..e5ae3e33fd 100644 --- a/classes/zh_CN/class_immediatemesh.rst +++ b/classes/zh_CN/class_immediatemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImmediateMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImmediateMesh.xml. .. _class_ImmediateMesh: @@ -211,6 +211,7 @@ ImmediateMesh 设置将与下一个顶点一起推送的 UV2 属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_importermesh.rst b/classes/zh_CN/class_importermesh.rst index cbff52c74b..68583481b3 100644 --- a/classes/zh_CN/class_importermesh.rst +++ b/classes/zh_CN/class_importermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImporterMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMesh.xml. .. _class_ImporterMesh: @@ -346,7 +346,7 @@ ImporterMesh 是一种类似于 :ref:`ArrayMesh` 的 :ref:`Reso |void| **set_blend_shape_mode**\ (\ mode\: :ref:`BlendShapeMode`\ ) :ref:`🔗` -将混合形状模式设置为 :ref:`BlendShapeMode` 之一。 +设置混合形状模式。 .. rst-class:: classref-item-separator @@ -385,6 +385,7 @@ ImporterMesh 是一种类似于 :ref:`ArrayMesh` 的 :ref:`Reso 设置给定曲面的名称。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_importermeshinstance3d.rst b/classes/zh_CN/class_importermeshinstance3d.rst index c9ce61e4c6..5753714380 100644 --- a/classes/zh_CN/class_importermeshinstance3d.rst +++ b/classes/zh_CN/class_importermeshinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ImporterMeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMeshInstance3D.xml. .. _class_ImporterMeshInstance3D: @@ -242,6 +242,7 @@ ImporterMeshInstance3D 该属性目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_input.rst b/classes/zh_CN/class_input.rst index f95c803f51..9bce8f19f8 100644 --- a/classes/zh_CN/class_input.rst +++ b/classes/zh_CN/class_input.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Input.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Input.xml. .. _class_Input: @@ -109,8 +109,12 @@ Input +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_just_pressed`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_just_pressed_by_event`\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_just_released`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_just_released_by_event`\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_pressed`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_anything_pressed`\ (\ ) |const| | @@ -438,7 +442,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 - |void| **set_mouse_mode**\ (\ value\: :ref:`MouseMode`\ ) - :ref:`MouseMode` **get_mouse_mode**\ (\ ) -控制鼠标模式。详见 :ref:`MouseMode`\ 。 +控制鼠标模式。 .. rst-class:: classref-item-separator @@ -602,7 +606,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`CursorShape` **get_current_cursor_shape**\ (\ ) |const| :ref:`🔗` -返回当前指定的光标形状（见 :ref:`CursorShape`\ ）。 +返回当前指定的光标形状。 .. rst-class:: classref-item-separator @@ -646,7 +650,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`float` **get_joy_axis**\ (\ device\: :ref:`int`, axis\: :ref:`JoyAxis`\ ) |const| :ref:`🔗` -返回给定索引（参见 :ref:`JoyAxis`\ ）处的游戏手柄轴的当前值。 +返回索引为 ``axis`` 的游戏手柄轴的当前值。 .. rst-class:: classref-item-separator @@ -672,27 +676,23 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`Dictionary` **get_joy_info**\ (\ device\: :ref:`int`\ ) |const| :ref:`🔗` -返回关于设备的额外平台相关信息字典，例如操作系统的原始游戏手柄名称，或者 Steam Input 索引。 +Returns a dictionary with extra platform-specific information about the device, e.g. the raw gamepad name from the OS or the Steam Input index. -在 Windows 上，该字典包含如下字段： +On Windows, Linux, and macOS, the dictionary contains the following fields: -\ ``xinput_index``\ ：控制器在 XInput 系统中的索引。如果是 DirectInput 设备则未定义。 +\ ``raw_name``: The name of the controller as it came from the OS, before getting renamed by the controller database. -\ ``vendor_id``\ ：设备的 USB 供应商 ID。 +\ ``vendor_id``: The USB vendor ID of the device. -\ ``product_id``\ ：设备的 USB 产品 ID。 +\ ``product_id``: The USB product ID of the device. -在 Linux 上： +\ ``steam_input_index``: The Steam Input gamepad index, if the device is not a Steam Input device this key won't be present. -\ ``raw_name``\ ：从操作系统获取的控制器名称，未经 Godot 控制器数据库重命名。 +On Windows, the dictionary can have an additional field: -\ ``vendor_id``\ ：设备的 USB 供应商 ID。 +\ ``xinput_index``: The index of the controller in the XInput system. This key won't be present for devices not handled by XInput. -\ ``product_id``\ ：设备的 USB 产品 ID。 - -\ ``steam_input_index``\ ：Steam Input 游戏手柄索引，如果该设备不是 Steam Input 设备则该字段不存在。 - -\ **注意：**\ 在 Web、iOS、Android 和 macOS 平台上，返回的字典始终为空。 +\ **Note:** The returned dictionary is always empty on Android, iOS, visionOS, and Web. .. rst-class:: classref-item-separator @@ -808,17 +808,37 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`bool` **is_action_just_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` -当用户在当前帧或物理周期中\ *开始*\ 按下动作事件时返回 ``true``\ 。只在用户按下按钮的那一帧或周期中为 ``true``\ 。 +Returns ``true`` when the user has *started* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user pressed down the button. -如果代码只需要在动作按下时执行一次，而不是只要处于按下状态就每帧都需要执行，那么这个方法就很有用。 +This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. -如果 ``exact_match`` 为 ``false``\ ，则会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 +If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. -\ **注意：**\ 返回 ``true`` 并不意味着该动作\ *仍然*\ 处于按下状态。动作在按下后是可以很快再释放的，为了不丢失输入，这种情况下仍然会返回 ``true``\ 。 +\ **Note:** Returning ``true`` does not imply that the action is *still* pressed. An action can be pressed and released again rapidly, and ``true`` will still be returned so as not to miss input. -\ **注意：**\ 由于键盘重影，即便该动作的某个键处于按下状态，\ :ref:`is_action_just_pressed()` 仍可能会返回 ``false``\ 。详见文档中的\ `《输入示例》 <../tutorials/inputs/input_examples.html#keyboard-events>`__\ 。 +\ **Note:** Due to keyboard ghosting, :ref:`is_action_just_pressed()` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. -\ **注意：**\ 在输入处理期间（例如 :ref:`Node._input()`\ ），请使用 :ref:`InputEvent.is_action_pressed()` 来查询当前事件的动作状态。 +\ **Note:** During input handling (e.g. :ref:`Node._input()`), use :ref:`InputEvent.is_action_pressed()` instead to query the action state of the current event. See also :ref:`is_action_just_pressed_by_event()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Input_method_is_action_just_pressed_by_event: + +.. rst-class:: classref-method + +:ref:`bool` **is_action_just_pressed_by_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` + +Returns ``true`` when the user has *started* pressing the action event in the current frame or physics tick, and the first event that triggered action press in the current frame/physics tick was ``event``. It will only return ``true`` on the frame or tick that the user pressed down the button. + +This is useful for code that needs to run only once when an action is pressed, and the action is processed during input handling (e.g. :ref:`Node._input()`). + +If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. + +\ **Note:** Returning ``true`` does not imply that the action is *still* pressed. An action can be pressed and released again rapidly, and ``true`` will still be returned so as not to miss input. + +\ **Note:** Due to keyboard ghosting, :ref:`is_action_just_pressed()` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. .. rst-class:: classref-item-separator @@ -830,13 +850,31 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`bool` **is_action_just_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` -当用户在当前帧或物理周期中\ *停止*\ 按下动作事件时返回 ``true``\ 。只在用户松开按钮的那一帧或周期中为 ``true``\ 。 +Returns ``true`` when the user *stops* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user releases the button. -\ **注意：**\ 返回 ``true`` 并不意味着该动作\ *仍然*\ 处于松开状态。动作在松开后是可以很快再按下的，为了不丢失输入，这种情况下仍然会返回 ``true``\ 。 +\ **Note:** Returning ``true`` does not imply that the action is *still* not pressed. An action can be released and pressed again rapidly, and ``true`` will still be returned so as not to miss input. -如果 ``exact_match`` 为 ``false``\ ，则会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 +If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. -\ **注意：**\ 在输入处理期间（例如 :ref:`Node._input()`\ ），请使用 :ref:`InputEvent.is_action_released()` 来查询当前事件的动作状态。 +\ **Note:** During input handling (e.g. :ref:`Node._input()`), use :ref:`InputEvent.is_action_released()` instead to query the action state of the current event. See also :ref:`is_action_just_released_by_event()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Input_method_is_action_just_released_by_event: + +.. rst-class:: classref-method + +:ref:`bool` **is_action_just_released_by_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` + +Returns ``true`` when the user *stops* pressing the action event in the current frame or physics tick, and the first event that triggered action release in the current frame/physics tick was ``event``. It will only return ``true`` on the frame or tick that the user releases the button. + +This is useful when an action is processed during input handling (e.g. :ref:`Node._input()`). + +\ **Note:** Returning ``true`` does not imply that the action is *still* not pressed. An action can be released and pressed again rapidly, and ``true`` will still be returned so as not to miss input. + +If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. .. rst-class:: classref-item-separator @@ -876,7 +914,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 :ref:`bool` **is_joy_button_pressed**\ (\ device\: :ref:`int`, button\: :ref:`JoyButton`\ ) |const| :ref:`🔗` -如果游戏手柄按钮（参见 :ref:`JoyButton`\ ）正被按下，则返回 ``true``\ 。 +如果索引为 ``button`` 的游戏手柄按钮处于按下状态，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1017,7 +1055,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 |void| **set_custom_mouse_cursor**\ (\ image\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` -设置自定义鼠标光标图像，该图像仅在游戏窗口内可见。还可以指定热点。将 ``null`` 传递给 image 参数将重置为系统光标。形状列表见 :ref:`CursorShape`\ 。 +设置自定义鼠标光标图像，该图像仅在游戏窗口内可见。还可以指定热点。将 ``null`` 传递给 image 参数将重置为系统光标。 \ ``image`` 可以是 :ref:`Texture2D` 或 :ref:`Image`\ ，其大小必须小于等于 256×256。为了避免渲染问题，建议使用小于等于 128×128 的大小。 @@ -1170,6 +1208,7 @@ I 形光标。通常用于指示点击鼠标后文本光标的位置。 \ **注意：**\ :ref:`warp_mouse()` 仅支持 Windows、macOS 和 Linux。它对 Android、iOS 和 Web 没有影响。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputevent.rst b/classes/zh_CN/class_inputevent.rst index 7d84780c1e..669e1fb0f5 100644 --- a/classes/zh_CN/class_inputevent.rst +++ b/classes/zh_CN/class_inputevent.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEvent.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEvent.xml. .. _class_InputEvent: @@ -194,7 +194,7 @@ InputEvent :ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, allow_echo\: :ref:`bool` = false, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` -如果给定的动作正被按下，则返回 ``true``\ （除非 ``allow_echo`` 为 ``true``\ ，否则不是 :ref:`InputEventKey` 事件中的回显事件）。与 :ref:`InputEventMouseMotion` 或 :ref:`InputEventScreenDrag` 类型的事件无关。 +如果给定的动作与该事件匹配且正被按下，则返回 ``true``\ （除非 ``allow_echo`` 为 ``true``\ ，否则不是 :ref:`InputEventKey` 事件中的回显事件）。与 :ref:`InputEventMouseMotion` 或 :ref:`InputEventScreenDrag` 类型的事件无关。 如果 ``exact_match`` 为 ``false``\ ，则它会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 @@ -210,7 +210,7 @@ InputEvent :ref:`bool` **is_action_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` -如果给定的动作被释放（即未按下），则返回 ``true``\ 。与 :ref:`InputEventMouseMotion` 或 :ref:`InputEventScreenDrag` 类型的事件无关。 +如果给定的动作与该事件匹配且被释放（即未按下），则返回 ``true``\ 。与 :ref:`InputEventMouseMotion` 或 :ref:`InputEventScreenDrag` 类型的事件无关。 如果 ``exact_match`` 为 ``false``\ ，它会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 @@ -224,7 +224,7 @@ InputEvent :ref:`bool` **is_action_type**\ (\ ) |const| :ref:`🔗` -如果这个输入事件的类型是可以分配给输入动作的类型，则返回 ``true``\ 。 +Returns ``true`` if this input event's type is one that can be assigned to an input action: :ref:`InputEventKey`, :ref:`InputEventMouseButton`, :ref:`InputEventJoypadButton`, :ref:`InputEventJoypadMotion`, :ref:`InputEventAction`. Returns ``false`` for all other input event types. .. rst-class:: classref-item-separator @@ -262,11 +262,11 @@ InputEvent :ref:`bool` **is_match**\ (\ event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = true\ ) |const| :ref:`🔗` -如果指定的 ``event`` 与该事件匹配，则返回 ``true``\ 。仅对动作事件有效，即键（\ :ref:`InputEventKey`\ ）、按钮（\ :ref:`InputEventMouseButton` 或 :ref:`InputEventJoypadButton`\ ）、轴 :ref:`InputEventJoypadMotion` 或动作（\ :ref:`InputEventAction`\ ）事件。 +如果指定的 ``event`` 与该事件匹配，则返回 ``true``\ 。仅对动作事件有效，包括按键事件（\ :ref:`InputEventKey`\ ）、按钮事件（\ :ref:`InputEventMouseButton` 或 :ref:`InputEventJoypadButton`\ ）、轴事件 :ref:`InputEventJoypadMotion`\ 、动作事件（\ :ref:`InputEventAction`\ ）。 -如果 ``exact_match`` 为 ``false``\ ，它会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 +如果 ``exact_match`` 为 ``false``\ ，检查时会忽略 :ref:`InputEventKey` 和 :ref:`InputEventMouseButton` 事件的额外输入修饰键，以及 :ref:`InputEventJoypadMotion` 事件的方向。 -\ **注意：**\ 只会考虑事件配置（例如键盘按键和游戏手柄轴），不会考虑 :ref:`is_pressed()`\ 、\ :ref:`is_released()`\ 、\ :ref:`is_echo()`\ 、\ :ref:`is_canceled()` 等状态信息。 +\ **注意：**\ 该方法只会考虑事件配置（例如键盘按键和游戏手柄轴），不会考虑 :ref:`is_pressed()`\ 、\ :ref:`is_released()`\ 、\ :ref:`is_echo()`\ 、\ :ref:`is_canceled()` 等状态信息。 .. rst-class:: classref-item-separator @@ -307,6 +307,7 @@ InputEvent 返回给定输入事件的副本，该副本已被 ``local_ofs`` 偏移并被 ``xform`` 变换。与 :ref:`InputEventMouseButton`\ 、\ :ref:`InputEventMouseMotion`\ 、\ :ref:`InputEventScreenTouch`\ 、\ :ref:`InputEventScreenDrag`\ 、\ :ref:`InputEventMagnifyGesture` 和 :ref:`InputEventPanGesture` 类型的事件相关。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventaction.rst b/classes/zh_CN/class_inputeventaction.rst index 77632a406c..23f9dd6587 100644 --- a/classes/zh_CN/class_inputeventaction.rst +++ b/classes/zh_CN/class_inputeventaction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventAction.xml. .. _class_InputEventAction: @@ -72,7 +72,7 @@ InputEventAction - |void| **set_action**\ (\ value\: :ref:`StringName`\ ) - :ref:`StringName` **get_action**\ (\ ) -动作的名称。动作可以通过此 :ref:`String` 访问。 +动作的名称。通常是你想要该自定义事件匹配的在 :ref:`InputMap` 中存在的动作。 .. rst-class:: classref-item-separator @@ -126,6 +126,7 @@ InputEventAction 动作的强度，介于 0 和 1 之间。当 pressed 为 ``false`` 时，该值被视为等于 0。通过将事件强度设置为手柄轴的弯曲或按压强度，可以仿造模拟手柄的移动事件。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventfromwindow.rst b/classes/zh_CN/class_inputeventfromwindow.rst index b20b65fe0d..69c703cde6 100644 --- a/classes/zh_CN/class_inputeventfromwindow.rst +++ b/classes/zh_CN/class_inputeventfromwindow.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventFromWindow.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventFromWindow.xml. .. _class_InputEventFromWindow: @@ -58,6 +58,7 @@ InputEventFromWindow 代表明确由窗口接收的事件。包括鼠标事件 接收这个事件的 :ref:`Window` 的 ID。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventgesture.rst b/classes/zh_CN/class_inputeventgesture.rst index 186817afba..94345bbe72 100644 --- a/classes/zh_CN/class_inputeventgesture.rst +++ b/classes/zh_CN/class_inputeventgesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventGesture.xml. .. _class_InputEventGesture: @@ -65,6 +65,7 @@ InputEventGesture 相对于\ :ref:`Viewport`\ 的本地手势位置。如果在\ :ref:`Control._gui_input()`\ 中使用，位置是相对于当前接收该手势的控件\ :ref:`Control`\ 而言的。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventjoypadbutton.rst b/classes/zh_CN/class_inputeventjoypadbutton.rst index 5f920c030b..9adfe52f48 100644 --- a/classes/zh_CN/class_inputeventjoypadbutton.rst +++ b/classes/zh_CN/class_inputeventjoypadbutton.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventJoypadButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventJoypadButton.xml. .. _class_InputEventJoypadButton: @@ -104,6 +104,7 @@ InputEventJoypadButton **已弃用：** This property is never set by the engine and is always ``0``. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventjoypadmotion.rst b/classes/zh_CN/class_inputeventjoypadmotion.rst index 362f4aad67..84604c7d80 100644 --- a/classes/zh_CN/class_inputeventjoypadmotion.rst +++ b/classes/zh_CN/class_inputeventjoypadmotion.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventJoypadMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventJoypadMotion.xml. .. _class_InputEventJoypadMotion: @@ -65,7 +65,7 @@ InputEventJoypadMotion - |void| **set_axis**\ (\ value\: :ref:`JoyAxis`\ ) - :ref:`JoyAxis` **get_axis**\ (\ ) -轴标识符。使用 :ref:`JoyAxis` 轴常量。 +轴标识符。 .. rst-class:: classref-item-separator @@ -85,6 +85,7 @@ InputEventJoypadMotion 操纵杆在给定轴上的当前位置。该值范围从 ``-1.0`` 到 ``1.0``\ 。值为 ``0`` 意味着轴处于静止位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventkey.rst b/classes/zh_CN/class_inputeventkey.rst index fc187d96c2..bd8c624692 100644 --- a/classes/zh_CN/class_inputeventkey.rst +++ b/classes/zh_CN/class_inputeventkey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventKey.xml. .. _class_InputEventKey: @@ -127,10 +127,10 @@ InputEventKey .. code:: text - +-----+ +-----+ - | Q | | Q | - "Q" - keycode - | Й | | ض | - "Й" and "ض" - key_label - +-----+ +-----+ + +-----+ +-----+ + | Q | | Q | - "Q" - keycode + | Й | | ض | - "Й" and "ض" - key_label + +-----+ +-----+ .. rst-class:: classref-item-separator @@ -153,10 +153,10 @@ InputEventKey .. code:: text - +-----+ +-----+ - | Q | | Q | - "Q" - 键码 - | Й | | ض | - "Й" 和 "ض" - key_label - +-----+ +-----+ + +-----+ +-----+ + | Q | | Q | - "Q" - 键码 + | Й | | ض | - "Й" 和 "ض" - key_label + +-----+ +-----+ .. rst-class:: classref-item-separator @@ -347,6 +347,7 @@ InputEventKey 要获得带有修饰符的 **InputEventKey** 的人类可读表示，请使用 ``OS.get_keycode_string(event.get_physical_keycode_with_modifiers())``\ ，其中 ``event`` 是 **InputEventKey**\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventmagnifygesture.rst b/classes/zh_CN/class_inputeventmagnifygesture.rst index b090eb52a2..8e883c855a 100644 --- a/classes/zh_CN/class_inputeventmagnifygesture.rst +++ b/classes/zh_CN/class_inputeventmagnifygesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventMagnifyGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMagnifyGesture.xml. .. _class_InputEventMagnifyGesture: @@ -65,6 +65,7 @@ InputEventMagnifyGesture 事件的量（或增量）。这个值越接近 ``1.0``\ ，手势执行地越快。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventmidi.rst b/classes/zh_CN/class_inputeventmidi.rst index 024132031e..0ef35727eb 100644 --- a/classes/zh_CN/class_inputeventmidi.rst +++ b/classes/zh_CN/class_inputeventmidi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventMIDI.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMIDI.xml. .. _class_InputEventMIDI: @@ -33,11 +33,11 @@ MIDI 消息可以通过 5 针 MIDI 连接器或 USB 接收。如果你的设备 func _ready(): OS.open_midi_inputs() print(OS.get_connected_midi_inputs()) - + func _input(input_event): if input_event is InputEventMIDI: _print_midi_info(input_event) - + func _print_midi_info(midi_event): print(midi_event) print("Channel ", midi_event.channel) @@ -56,7 +56,7 @@ MIDI 消息可以通过 5 针 MIDI 连接器或 USB 接收。如果你的设备 OS.OpenMidiInputs(); GD.Print(OS.GetConnectedMidiInputs()); } - + public override void _Input(InputEvent inputEvent) { if (inputEvent is InputEventMidi midiEvent) @@ -64,7 +64,7 @@ MIDI 消息可以通过 5 针 MIDI 连接器或 USB 接收。如果你的设备 PrintMIDIInfo(midiEvent); } } - + private void PrintMIDIInfo(InputEventMidi midiEvent) { GD.Print(midiEvent); @@ -280,6 +280,7 @@ MIDI 消息的速度。这个值在 ``0`` 到 ``127`` 之间。对于音乐键 print("Note pressed!") .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventmouse.rst b/classes/zh_CN/class_inputeventmouse.rst index 347d7846df..61bcadbcc5 100644 --- a/classes/zh_CN/class_inputeventmouse.rst +++ b/classes/zh_CN/class_inputeventmouse.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventMouse.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouse.xml. .. _class_InputEventMouse: @@ -107,6 +107,7 @@ InputEventMouse 在 :ref:`Control._gui_input()` 中获取时，返回该 :ref:`Control` 中鼠标的位置，使用该 :ref:`Control` 的坐标系。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventmousebutton.rst b/classes/zh_CN/class_inputeventmousebutton.rst index 373a1df7cc..3262184fff 100644 --- a/classes/zh_CN/class_inputeventmousebutton.rst +++ b/classes/zh_CN/class_inputeventmousebutton.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventMouseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouseButton.xml. .. _class_InputEventMouseButton: @@ -146,6 +146,7 @@ InputEventMouseButton 如果为 ``true``\ ，鼠标按键的状态为按下。如果为 ``false``\ ，鼠标按钮的状态被释放。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventmousemotion.rst b/classes/zh_CN/class_inputeventmousemotion.rst index 03646d3c7b..475facef36 100644 --- a/classes/zh_CN/class_inputeventmousemotion.rst +++ b/classes/zh_CN/class_inputeventmousemotion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventMouseMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouseMotion.xml. .. _class_InputEventMouseMotion: @@ -158,7 +158,9 @@ InputEventMouseMotion - |void| **set_screen_velocity**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_screen_velocity**\ (\ ) -屏幕坐标中未缩放的鼠标速度（单位为每秒像素数）。该速度\ *不*\ 根据内容缩放系数或对 :ref:`InputEvent.xformed_by()` 的调用进行缩放。当使用 :ref:`Input.MOUSE_MODE_CAPTURED` 鼠标模式时，无论项目的拉伸模式如何，这都应该优先于鼠标瞄准的 :ref:`velocity`\ 。 +屏幕坐标中未缩放的鼠标速度（单位为每秒像素数）。该速度\ *不会*\ 根据内容缩放系数或对 :ref:`InputEvent.xformed_by()` 的调用进行缩放。 + +\ **注意：**\ 使用 :ref:`Input.MOUSE_MODE_CAPTURED` 鼠标模式时，请使用 :ref:`screen_relative` 实现鼠标瞄准。 .. rst-class:: classref-item-separator @@ -192,11 +194,14 @@ InputEventMouseMotion - |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_velocity**\ (\ ) -鼠标速度（单位为像素每秒）。 +鼠标速度，单位为像素每秒。 -\ **注意：**\ :ref:`velocity` 根据内容缩放系数自动缩放，内容缩放系数由项目的拉伸模式设置定义。这意味着在使用 :ref:`Input.MOUSE_MODE_CAPTURED` 鼠标模式处理鼠标瞄准的脚本中使用 :ref:`velocity` 时，鼠标灵敏度将根据分辨率而有所不同。为了避免这种情况，请改用 :ref:`screen_velocity`\ 。 +\ **注意：**\ :ref:`velocity` 会根据内容缩放系数自动缩放，内容缩放系数由项目的拉伸模式设置定义。这意味着鼠标灵敏度将根据分辨率而有所不同。 + +\ **注意：**\ 使用 :ref:`Input.MOUSE_MODE_CAPTURED` 鼠标模式时，请使用 :ref:`screen_relative` 实现鼠标瞄准。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventpangesture.rst b/classes/zh_CN/class_inputeventpangesture.rst index b5e3855a4f..6c873ab480 100644 --- a/classes/zh_CN/class_inputeventpangesture.rst +++ b/classes/zh_CN/class_inputeventpangesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventPanGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventPanGesture.xml. .. _class_InputEventPanGesture: @@ -65,6 +65,7 @@ InputEventPanGesture 上一次平移事件以来的平移量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventscreendrag.rst b/classes/zh_CN/class_inputeventscreendrag.rst index 1b223a27c6..0e0269bf38 100644 --- a/classes/zh_CN/class_inputeventscreendrag.rst +++ b/classes/zh_CN/class_inputeventscreendrag.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventScreenDrag.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventScreenDrag.xml. .. _class_InputEventScreenDrag: @@ -219,6 +219,7 @@ InputEventScreenDrag \ **注意：**\ :ref:`velocity` 根据内容缩放系数自动缩放，内容缩放系数由项目的拉伸模式设置定义。这意味着在处理触摸瞄准的脚本中使用 :ref:`velocity` 时，触摸灵敏度将根据分辨率而表现不同。为了避免这种情况，请改用 :ref:`screen_velocity`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventscreentouch.rst b/classes/zh_CN/class_inputeventscreentouch.rst index 1d2c9498fe..e341360e0b 100644 --- a/classes/zh_CN/class_inputeventscreentouch.rst +++ b/classes/zh_CN/class_inputeventscreentouch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventScreenTouch.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventScreenTouch.xml. .. _class_InputEventScreenTouch: @@ -139,6 +139,7 @@ InputEventScreenTouch 如果为 ``true``\ ，触摸的状态为按下。如果为 ``false``\ ，触摸的状态被释放。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventshortcut.rst b/classes/zh_CN/class_inputeventshortcut.rst index 2a5f8c2497..81823cba0b 100644 --- a/classes/zh_CN/class_inputeventshortcut.rst +++ b/classes/zh_CN/class_inputeventshortcut.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventShortcut.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventShortcut.xml. .. _class_InputEventShortcut: @@ -56,6 +56,7 @@ InputEventShortcut 是一种可以在 :ref:`Node._input()`\ 。它的 :ref:`Shortcut.matches_event()` 方法对这个事件始终返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputeventwithmodifiers.rst b/classes/zh_CN/class_inputeventwithmodifiers.rst index 6c50f33a8e..dbea864268 100644 --- a/classes/zh_CN/class_inputeventwithmodifiers.rst +++ b/classes/zh_CN/class_inputeventwithmodifiers.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputEventWithModifiers.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventWithModifiers.xml. .. _class_InputEventWithModifiers: @@ -188,6 +188,7 @@ InputEventWithModifiers 在其他平台上，如果 :kbd:`Ctrl` 是按下状态，则返回 ``true`` 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_inputmap.rst b/classes/zh_CN/class_inputmap.rst index b50555a3f2..6882d26de6 100644 --- a/classes/zh_CN/class_inputmap.rst +++ b/classes/zh_CN/class_inputmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InputMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputMap.xml. .. _class_InputMap: @@ -57,6 +57,8 @@ InputMap +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`event_is_action`\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_action_description`\ (\ action\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_actions`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_action`\ (\ action\: :ref:`StringName`\ ) |const| | @@ -199,6 +201,18 @@ InputMap ---- +.. _class_InputMap_method_get_action_description: + +.. rst-class:: classref-method + +:ref:`String` **get_action_description**\ (\ action\: :ref:`StringName`\ ) |const| :ref:`🔗` + +返回给定动作的人类可读描述。 + +.. rst-class:: classref-item-separator + +---- + .. _class_InputMap_method_get_actions: .. rst-class:: classref-method @@ -232,6 +246,7 @@ InputMap 清除 **InputMap** 中的所有 :ref:`InputEventAction`\ ，并从 :ref:`ProjectSettings` 项目设置中重新加载它。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_instanceplaceholder.rst b/classes/zh_CN/class_instanceplaceholder.rst index 47648baa4c..4640015b7b 100644 --- a/classes/zh_CN/class_instanceplaceholder.rst +++ b/classes/zh_CN/class_instanceplaceholder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/InstancePlaceholder.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InstancePlaceholder.xml. .. _class_InstancePlaceholder: @@ -21,7 +21,7 @@ InstancePlaceholder 在编辑器中为实例化的场景打开\ **加载为占位符**\ 选项会导致在运行游戏时将其替换为 **InstancePlaceholder**\ 。这样就可以将场景的实际加载推迟到调用 :ref:`create_instance()` 时。这对于通过选择性加载部分场景来避免一次性加载大场景很有用。 -\ **InstancePlaceholder** 不具备变换属性。因此任何子节点都会相对于 :ref:`Viewport` 从 (0, 0) 点开始定位，而不是在编辑器中显示的父节点。用一个具有变换属性的场景来替换占位符，将使子节点再次相对于它们的父节点进行变换。 +\ **注意：**\ **InstancePlaceholder** 与 :ref:`Node` 类似，不具备变换属性。因此任何子节点都会相对于 :ref:`Viewport` 的原点开始定位，而不是在编辑器中显示的父节点。用一个具有变换属性的场景来替换占位符，将使子节点再次相对于它们的父节点进行变换。 .. rst-class:: classref-reftable-group @@ -85,6 +85,7 @@ InstancePlaceholder 如果 ``with_order`` 为 ``true``\ ，会在字典中加入 ``.order`` 字段（注意有个前缀的点）。这个 ``.order`` 字段是属性名称 :ref:`String` 的 :ref:`Array`\ ，指定属性的应用顺序（索引为 0 的是第一个）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_int.rst b/classes/zh_CN/class_int.rst index 3e0214971d..00e3098b89 100644 --- a/classes/zh_CN/class_int.rst +++ b/classes/zh_CN/class_int.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/int.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/int.xml. .. _class_int: @@ -42,7 +42,7 @@ int // 下面使用 long，因为 GDScript 的 int 为 64 位，而 C# 的 int 为 32 位。 long maxLong = 9223372036854775807; // long 所能存储的最大值 maxLong++; // maxLong 现在是 -9223372036854775808，因为它绕到了另一端。 - + // 也可以使用 C# 的 32 位 int 类型，最大值较小。 int maxInt = 2147483647; // int 所能存储的最大值 maxInt++; // maxInt 现在是 -2147483648，因为它绕到了另一端。 @@ -777,6 +777,7 @@ int print(~(-7)) # 输出 6 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_intervaltweener.rst b/classes/zh_CN/class_intervaltweener.rst index 2f21774750..d0473cf9dc 100644 --- a/classes/zh_CN/class_intervaltweener.rst +++ b/classes/zh_CN/class_intervaltweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/IntervalTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/IntervalTweener.xml. .. _class_IntervalTweener: @@ -24,6 +24,7 @@ IntervalTweener \ **注意：**\ 创建 **IntervalTweener** 的唯一正确方法是 :ref:`Tween.tween_interval()`\ 。任何手动创建的 **IntervalTweener** 都无法正常工作。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_ip.rst b/classes/zh_CN/class_ip.rst index 60774f4501..9279af4f1f 100644 --- a/classes/zh_CN/class_ip.rst +++ b/classes/zh_CN/class_ip.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/IP.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/IP.xml. .. _class_IP: @@ -305,6 +305,7 @@ enum **Type**: :ref:`🔗` 创建一个队列项目，根据 :ref:`Type` 常量 ``ip_type``\ ，将主机名解析为 IPv4 或 IPv6 地址。如果成功，则返回队列 ID，否则返回 :ref:`RESOLVER_INVALID_ID`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_itemlist.rst b/classes/zh_CN/class_itemlist.rst index e40d953a5a..0fe1bfd503 100644 --- a/classes/zh_CN/class_itemlist.rst +++ b/classes/zh_CN/class_itemlist.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ItemList.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ItemList.xml. .. _class_ItemList: @@ -641,7 +641,7 @@ enum **SelectMode**: :ref:`🔗` - |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) - :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) -设置文本超出项目的边界矩形时的裁剪行为。所有模式的说明见 :ref:`OverrunBehavior`\ 。 +当文本超出项目的边界矩形时的裁剪行为。 .. rst-class:: classref-item-separator @@ -1400,7 +1400,7 @@ enum **SelectMode**: :ref:`🔗` :ref:`int` **v_separation** = ``4`` :ref:`🔗` -项目菜单之间的垂直间距。 +项目之间的垂直间距。 .. rst-class:: classref-item-separator @@ -1535,6 +1535,7 @@ enum **SelectMode**: :ref:`🔗` 所选项的样式盒 :ref:`StyleBox`\ ，当该 **ItemList** 获得焦点时使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_javaclass.rst b/classes/zh_CN/class_javaclass.rst index 8990b9f019..a98e3c125d 100644 --- a/classes/zh_CN/class_javaclass.rst +++ b/classes/zh_CN/class_javaclass.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JavaClass.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaClass.xml. .. _class_JavaClass: @@ -83,6 +83,7 @@ JavaClass 返回代表该类的 Java 父类的 **JavaClass**\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_javaclasswrapper.rst b/classes/zh_CN/class_javaclasswrapper.rst index 207e22dcb5..75fc2b63ae 100644 --- a/classes/zh_CN/class_javaclasswrapper.rst +++ b/classes/zh_CN/class_javaclasswrapper.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JavaClassWrapper.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaClassWrapper.xml. .. _class_JavaClassWrapper: @@ -27,14 +27,21 @@ JavaClassWrapper 单例为 Godot 应用程序提供了一种通过 `Java 原生 var LocalDateTime = JavaClassWrapper.wrap("java.time.LocalDateTime") var DateTimeFormatter = JavaClassWrapper.wrap("java.time.format.DateTimeFormatter") - + var datetime = LocalDateTime.now() var formatter = DateTimeFormatter.ofPattern("dd-MM-yyyy HH:mm:ss") - + print(datetime.format(formatter)) \ **警告：**\ 调用 Java 方法时，请确保使用 :ref:`get_exception()` 检查该方法是否抛出了异常。 +.. rst-class:: classref-introduction-group + +教程 +---- + +- :doc:`与 Android API 的集成 <../tutorials/platform/android/javaclasswrapper_and_androidruntimeplugin>` + .. rst-class:: classref-reftable-group 方法 @@ -82,9 +89,17 @@ JavaClassWrapper 单例为 Godot 应用程序提供了一种通过 `Java 原生 包装内部（嵌套）类时请使用 ``$`` 分隔，不要用 ``.``\ 。例如 **WindowManager.LayoutParams** 类应使用 ``JavaClassWrapper.wrap("android.view.WindowManager$LayoutParams")`` 进行包装。 +\ **注意：**\ 调用构造函数请调用与类同名的方法。例如： + +:: + + var Intent = JavaClassWrapper.wrap("android.content.Intent") + var intent = Intent.Intent() + \ **注意：**\ 该方法仅适用于 Android，在其他所有平台上都不会执行任何操作，返回的是空的 :ref:`JavaClass`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_javaobject.rst b/classes/zh_CN/class_javaobject.rst index e9eb55b347..193c977f97 100644 --- a/classes/zh_CN/class_javaobject.rst +++ b/classes/zh_CN/class_javaobject.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JavaObject.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaObject.xml. .. _class_JavaObject: @@ -55,6 +55,7 @@ JavaObject 返回该对象实例对应的 :ref:`JavaClass` 类。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_javascriptbridge.rst b/classes/zh_CN/class_javascriptbridge.rst index ab4b1c9f61..a094d6e23a 100644 --- a/classes/zh_CN/class_javascriptbridge.rst +++ b/classes/zh_CN/class_javascriptbridge.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JavaScriptBridge.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScriptBridge.xml. .. _class_JavaScriptBridge: @@ -221,6 +221,7 @@ JavaScriptBridge 单例仅在 Web 导出中实现。它用于访问浏览器的 \ **注意：**\ 只在导出为渐进式网络应用程序（Progressive Web App）且 :ref:`pwa_needs_update()` 返回 ``true`` 时相关。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_javascriptobject.rst b/classes/zh_CN/class_javascriptobject.rst index 10fd85f91b..4b80c4fe19 100644 --- a/classes/zh_CN/class_javascriptobject.rst +++ b/classes/zh_CN/class_javascriptobject.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JavaScriptObject.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScriptObject.xml. .. _class_JavaScriptObject: @@ -24,23 +24,23 @@ JavaScriptObject 用于与通过 :ref:`JavaScriptBridge.get_interface()`__ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_joint2d.rst b/classes/zh_CN/class_joint2d.rst index 4d536ac693..0e4b123744 100644 --- a/classes/zh_CN/class_joint2d.rst +++ b/classes/zh_CN/class_joint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Joint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Joint2D.xml. .. _class_Joint2D: @@ -146,6 +146,7 @@ Joint2D 从 :ref:`PhysicsServer2D` 返回关节的内部 :ref:`RID`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_joint3d.rst b/classes/zh_CN/class_joint3d.rst index 42b8486f19..c8d9ea5a85 100644 --- a/classes/zh_CN/class_joint3d.rst +++ b/classes/zh_CN/class_joint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Joint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Joint3D.xml. .. _class_Joint3D: @@ -155,6 +155,7 @@ Joint3D 从 :ref:`PhysicsServer3D` 返回关节的内部 :ref:`RID`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_json.rst b/classes/zh_CN/class_json.rst index ef4b286940..efe0b313a7 100644 --- a/classes/zh_CN/class_json.rst +++ b/classes/zh_CN/class_json.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JSON.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JSON.xml. .. _class_JSON: @@ -19,11 +19,11 @@ JSON 描述 ---- -**JSON** 类允许所有数据类型与 JSON 字符串相互转换。可用于将数据序列化，从而保存到文件或通过网络发送。 +**JSON** 类允许所有数据类型与 JSON 字符串相互转换。可用于将数据序列化，例如保存到文件或通过网络发送。 \ :ref:`stringify()` 用于将任何数据类型转换为 JSON 字符串。 -\ :ref:`parse()` 用于将任何现有的 JSON 数据转换为可以在 Godot 中使用的 :ref:`Variant`\ 。如果解析成功，使用 :ref:`data` 检索 :ref:`Variant`\ ，并使用 ``typeof`` 检查 Variant 的类型是否符合你的预期。JSON 对象被转换为 :ref:`Dictionary`\ ，但 JSON 数据可用于存储 :ref:`Array`\ 、数字、\ :ref:`String`\ ，甚至只是一个布尔值。 +\ :ref:`parse()` 用于将任何现有的 JSON 数据转换为可以在 Godot 中使用的 :ref:`Variant`\ 。如果解析成功，使用 :ref:`data` 检索 :ref:`Variant`\ ，并使用 :ref:`@GlobalScope.typeof()` 检查 Variant 的类型是否符合你的预期。JSON 对象被转换为 :ref:`Dictionary`\ ，但 JSON 数据可用于存储 :ref:`Array`\ 、数字、\ :ref:`String`\ ，甚至只是一个布尔值。 :: @@ -57,7 +57,7 @@ JSON - 使用 :ref:`String.to_float()` 解析数字，这通常比 JSON 规范更宽松。 -- 某些错误，例如无效的 Unicode 序列，不会导致解析器错误。相反，该字符串会被清理并将错误记录到控制台。 +- 某些错误不会导致解析器错误，例如 Unicode 序列无效，但是该字符串会被清理并将错误记录到控制台。 .. rst-class:: classref-reftable-group @@ -235,7 +235,7 @@ JSON ## JSON.stringify(my_dictionary) {"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]} - + ## JSON.stringify(my_dictionary, "\t") { "name": "my_dictionary", @@ -251,7 +251,7 @@ JSON } ] } - + ## JSON.stringify(my_dictionary, "...") { ..."name": "my_dictionary", @@ -290,6 +290,7 @@ JSON return JSON.to_native(JSON.parse_string(string), allow_objects) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_jsonrpc.rst b/classes/zh_CN/class_jsonrpc.rst index c1c9044820..a387347f05 100644 --- a/classes/zh_CN/class_jsonrpc.rst +++ b/classes/zh_CN/class_jsonrpc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/JSONRPC.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JSONRPC.xml. .. _class_JSONRPC: @@ -42,7 +42,7 @@ JSONRPC +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`process_string`\ (\ action\: :ref:`String`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_scope`\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) | + | |void| | :ref:`set_method`\ (\ name\: :ref:`String`, callback\: :ref:`Callable`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -207,17 +207,20 @@ enum **ErrorCode**: :ref:`🔗` ---- -.. _class_JSONRPC_method_set_scope: +.. _class_JSONRPC_method_set_method: .. rst-class:: classref-method -|void| **set_scope**\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) :ref:`🔗` +|void| **set_method**\ (\ name\: :ref:`String`, callback\: :ref:`Callable`\ ) :ref:`🔗` -.. container:: contribute +为给定的方法名注册回调。 - 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ +- ``name`` 客户端能够用来访问该回调的名称。 + +- ``callback`` 处理指定方法的回调。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_kinematiccollision2d.rst b/classes/zh_CN/class_kinematiccollision2d.rst index f4ad840f53..26549bf32a 100644 --- a/classes/zh_CN/class_kinematiccollision2d.rst +++ b/classes/zh_CN/class_kinematiccollision2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/KinematicCollision2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/KinematicCollision2D.xml. .. _class_KinematicCollision2D: @@ -221,6 +221,7 @@ KinematicCollision2D 返回移动对象的在碰撞前的运动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_kinematiccollision3d.rst b/classes/zh_CN/class_kinematiccollision3d.rst index ab188c03ad..30e74964f0 100644 --- a/classes/zh_CN/class_kinematiccollision3d.rst +++ b/classes/zh_CN/class_kinematiccollision3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/KinematicCollision3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/KinematicCollision3D.xml. .. _class_KinematicCollision3D: @@ -235,6 +235,7 @@ KinematicCollision3D 返回移动对象的在碰撞前的运动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_label.rst b/classes/zh_CN/class_label.rst index 0f1c2b2d65..7bcb21c80f 100644 --- a/classes/zh_CN/class_label.rst +++ b/classes/zh_CN/class_label.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Label.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Label.xml. .. _class_Label: @@ -42,6 +42,8 @@ Label +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ellipsis_char` | ``"…"`` | @@ -138,6 +140,8 @@ Label +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ @@ -161,7 +165,24 @@ Label - |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) - :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) -如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。要了解每种模式的行为方式，请参阅 :ref:`AutowrapMode`\ 。 +如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Label_property_autowrap_trim_flags: + +.. rst-class:: classref-property + +|bitfield|\[:ref:`LineBreakFlag`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +自动换行空格修剪标志。详见 :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` 和 :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES`\ 。 .. rst-class:: classref-item-separator @@ -212,7 +233,7 @@ Label - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。请将其设置为 :ref:`HorizontalAlignment` 常量。 +控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。 .. rst-class:: classref-item-separator @@ -229,7 +250,7 @@ Label - |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) - |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) -行两端对齐规则。详见 :ref:`JustificationFlag`\ 。 +行填充对齐规则。 .. rst-class:: classref-item-separator @@ -418,7 +439,7 @@ Label - |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) - :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) -设置文本超出节点的边界矩形时的裁剪行为。有关所有模式的描述，请参阅 :ref:`OverrunBehavior`\ 。 +设置文本超出节点边界框时的裁剪行为。 .. rst-class:: classref-item-separator @@ -452,7 +473,7 @@ Label - |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) - :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) -控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐和填充。将其设置为 :ref:`VerticalAlignment` 常量之一。 +控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐、填充。 .. rst-class:: classref-item-separator @@ -469,9 +490,11 @@ Label - |void| **set_visible_characters**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_visible_characters**\ (\ ) -要显示的字符数。如果设置为 ``-1``\ ，则显示所有字符。这用于在对话框中为显示的文本设置动画。 +The number of characters to display. If set to ``-1``, all characters are displayed. This can be useful when animating the text appearing in a dialog box. -\ **注意：**\ 设置该属性会相应地更新 :ref:`visible_ratio`\ 。 +\ **Note:** Setting this property updates :ref:`visible_ratio` accordingly. + +\ **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings. .. rst-class:: classref-item-separator @@ -488,7 +511,7 @@ Label - |void| **set_visible_characters_behavior**\ (\ value\: :ref:`VisibleCharactersBehavior`\ ) - :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior**\ (\ ) -设置 :ref:`visible_characters` 或 :ref:`visible_ratio` 被设置时的裁剪行为。有关详细信息，请参阅 :ref:`VisibleCharactersBehavior`\ 。 +设置 :ref:`visible_characters` 或 :ref:`visible_ratio` 被设置时的裁剪行为。 .. rst-class:: classref-item-separator @@ -723,6 +746,18 @@ Label ---- +.. _class_Label_theme_style_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **focus** :ref:`🔗` + +**Label** 处于聚焦状态时使用的 :ref:`StyleBox`\ （适用于使用辅助应用）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Label_theme_style_normal: .. rst-class:: classref-themeproperty @@ -732,6 +767,7 @@ Label 为 **Label** 设置背景样式盒 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_label3d.rst b/classes/zh_CN/class_label3d.rst index 7c8f417b54..cd1f811a0a 100644 --- a/classes/zh_CN/class_label3d.rst +++ b/classes/zh_CN/class_label3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Label3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Label3D.xml. .. _class_Label3D: @@ -52,6 +52,8 @@ Label3D +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`ShadowCastingSetting` | cast_shadow | ``0`` (overrides :ref:`GeometryInstance3D`) | @@ -265,7 +267,7 @@ enum **AlphaCutMode**: :ref:`🔗` - |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) - :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) -要应用的 Alpha 抗锯齿类型。见 :ref:`AlphaAntiAliasing`\ 。 +要应用的 Alpha 抗锯齿类型。 .. rst-class:: classref-item-separator @@ -282,7 +284,7 @@ enum **AlphaCutMode**: :ref:`🔗` - |void| **set_alpha_cut_mode**\ (\ value\: :ref:`AlphaCutMode`\ ) - :ref:`AlphaCutMode` **get_alpha_cut_mode**\ (\ ) -该精灵的 Alpha 裁剪模式。可能的取值见 :ref:`AlphaCutMode`\ 。 +精灵所使用的 Alpha 剪切模式。 .. rst-class:: classref-item-separator @@ -333,7 +335,24 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) - :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) -如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。要了解每种模式的行为方式，请参阅 :ref:`AutowrapMode`\ 。 +如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Label3D_property_autowrap_trim_flags: + +.. rst-class:: classref-property + +|bitfield|\[:ref:`LineBreakFlag`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +自动换行空格修剪标志。详见 :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` 和 :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES`\ 。 .. rst-class:: classref-item-separator @@ -350,7 +369,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) - :ref:`BillboardMode` **get_billboard_mode**\ (\ ) -该标签的公告板模式。可能的值见 :ref:`BillboardMode`\ 。 +标签使用的公告板模式。 .. rst-class:: classref-item-separator @@ -384,7 +403,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| -如果为 ``true``\ ，则无论距离远近，标签都以相同的尺寸呈现。 +如果为 ``true``\ ，则标签始终以相同的大小渲染，忽略距离。标签在屏幕上的大小与相机距离标签原点 ``1.0`` 单位时相同，忽略与相机的实际距离。\ :ref:`Camera3D` 的视野（使用正交/视锥模式时则为 :ref:`Camera3D.size`\ ）仍然会影响标签绘制的大小。 .. rst-class:: classref-item-separator @@ -437,7 +456,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。请将其设置为 :ref:`HorizontalAlignment` 常量。 +控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。 .. rst-class:: classref-item-separator @@ -454,7 +473,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) - |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) -行两端对齐规则。详见 :ref:`JustificationFlag`\ 。 +行填充对齐规则。 .. rst-class:: classref-item-separator @@ -734,7 +753,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) -纹理的过滤标志。选项见 :ref:`TextureFilter`\ 。 +纹理的过滤标志。 .. rst-class:: classref-item-separator @@ -768,7 +787,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) - :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) -控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐。请将其设置为 :ref:`VerticalAlignment` 常量。 +控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐。 .. rst-class:: classref-item-separator @@ -826,9 +845,10 @@ Alpha 裁剪丢弃数值的阈值。 |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` -如果为 ``true``\ ，会启用指定的标志。标志列表请参阅 :ref:`DrawFlags`\ 。 +如果为 ``true``\ ，则启用 ``flag`` 指定的标志。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_labelsettings.rst b/classes/zh_CN/class_labelsettings.rst index dacc468b3b..a11f4a33c7 100644 --- a/classes/zh_CN/class_labelsettings.rst +++ b/classes/zh_CN/class_labelsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LabelSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LabelSettings.xml. .. _class_LabelSettings: @@ -29,27 +29,73 @@ LabelSettings .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Font` | :ref:`font` | | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`font_size` | ``16`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`line_spacing` | ``3.0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`outline_color` | ``Color(1, 1, 1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`paragraph_spacing` | ``0.0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`shadow_color` | ``Color(0, 0, 0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Vector2` | :ref:`shadow_offset` | ``Vector2(1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`shadow_size` | ``1`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Font` | :ref:`font` | | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`font_size` | ``16`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`line_spacing` | ``3.0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`outline_color` | ``Color(1, 1, 1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`paragraph_spacing` | ``0.0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`shadow_color` | ``Color(0, 0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Vector2` | :ref:`shadow_offset` | ``Vector2(1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`shadow_size` | ``1`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stacked_outline_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stacked_shadow_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_stacked_outline`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_stacked_shadow`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_stacked_outline_color`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_stacked_outline_size`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_stacked_shadow_color`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_stacked_shadow_offset`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_stacked_shadow_outline_size`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_stacked_outline`\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_stacked_shadow`\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_stacked_outline`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_stacked_shadow`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_outline_color`\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_outline_size`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_color`\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_offset`\ (\ index\: :ref:`int`, offset\: :ref:`Vector2`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_outline_size`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -226,7 +272,239 @@ LabelSettings 阴影效果的大小。 +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_property_stacked_outline_count: + +.. rst-class:: classref-property + +:ref:`int` **stacked_outline_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stacked_outline_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stacked_outline_count**\ (\ ) + +堆叠轮廓的数量。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_property_stacked_shadow_count: + +.. rst-class:: classref-property + +:ref:`int` **stacked_shadow_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stacked_shadow_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stacked_shadow_count**\ (\ ) + +堆叠阴影的数量。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_LabelSettings_method_add_stacked_outline: + +.. rst-class:: classref-method + +|void| **add_stacked_outline**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` + +为标签在索引为 ``index`` 处添加新的堆叠轮廓。如果 ``index`` 为 ``-1``\ ，则新的堆叠轮廓会添加到列表的末尾。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_add_stacked_shadow: + +.. rst-class:: classref-method + +|void| **add_stacked_shadow**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` + +为标签在索引为 ``index`` 处添加新的堆叠阴影。如果 ``index`` 为 ``-1``\ ，则新的堆叠阴影会添加到列表的末尾。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_outline_color: + +.. rst-class:: classref-method + +:ref:`Color` **get_stacked_outline_color**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的堆叠轮廓的颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_outline_size: + +.. rst-class:: classref-method + +:ref:`int` **get_stacked_outline_size**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的堆叠轮廓的大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_color: + +.. rst-class:: classref-method + +:ref:`Color` **get_stacked_shadow_color**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的堆叠阴影的颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_offset: + +.. rst-class:: classref-method + +:ref:`Vector2` **get_stacked_shadow_offset**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的堆叠阴影的偏移量。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_outline_size: + +.. rst-class:: classref-method + +:ref:`int` **get_stacked_shadow_outline_size**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的堆叠阴影的轮廓大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_move_stacked_outline: + +.. rst-class:: classref-method + +|void| **move_stacked_outline**\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``from_index`` 的堆叠轮廓移动至数组中的 ``to_position`` 位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_move_stacked_shadow: + +.. rst-class:: classref-method + +|void| **move_stacked_shadow**\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``from_index`` 的堆叠阴影移动至数组中的 ``to_position`` 位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_remove_stacked_outline: + +.. rst-class:: classref-method + +|void| **remove_stacked_outline**\ (\ index\: :ref:`int`\ ) :ref:`🔗` + +移除索引为 ``index`` 的堆叠轮廓。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_remove_stacked_shadow: + +.. rst-class:: classref-method + +|void| **remove_stacked_shadow**\ (\ index\: :ref:`int`\ ) :ref:`🔗` + +移除索引为 ``index`` 的堆叠阴影。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_outline_color: + +.. rst-class:: classref-method + +|void| **set_stacked_outline_color**\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` + +将索引为 ``index`` 的堆叠轮廓的颜色设为 ``color``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_outline_size: + +.. rst-class:: classref-method + +|void| **set_stacked_outline_size**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``index`` 的堆叠轮廓的大小设为 ``size``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_color: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_color**\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` + +将索引为 ``index`` 的堆叠阴影的颜色设为 ``color``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_offset: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_offset**\ (\ index\: :ref:`int`, offset\: :ref:`Vector2`\ ) :ref:`🔗` + +将索引为 ``index`` 的堆叠阴影的偏移量设为 ``offset``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_outline_size: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_outline_size**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +将索引为 ``index`` 的堆叠阴影的轮廓大小设为 ``size``\ 。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_light2d.rst b/classes/zh_CN/class_light2d.rst index b202d3abdc..f9b8934acb 100644 --- a/classes/zh_CN/class_light2d.rst +++ b/classes/zh_CN/class_light2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Light2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Light2D.xml. .. _class_Light2D: @@ -177,7 +177,7 @@ enum **BlendMode**: :ref:`🔗` - |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) - :ref:`BlendMode` **get_blend_mode**\ (\ ) -该 Light2D 的混合模式。取值见 :ref:`BlendMode` 常量。 +该 Light2D 的混合模式。 .. rst-class:: classref-item-separator @@ -383,7 +383,7 @@ Light2D 的能量值。该值越大，光线就越强。 - |void| **set_shadow_filter**\ (\ value\: :ref:`ShadowFilter`\ ) - :ref:`ShadowFilter` **get_shadow_filter**\ (\ ) -阴影过滤器类型。可能的取值见 :ref:`ShadowFilter`\ 。 +阴影过滤类型。 .. rst-class:: classref-item-separator @@ -449,6 +449,7 @@ Light2D 的能量值。该值越大，光线就越强。 设置该灯光的高度，用于 2D 法线映射。见 :ref:`PointLight2D.height` 和 :ref:`DirectionalLight2D.height`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_light3d.rst b/classes/zh_CN/class_light3d.rst index cd02968c32..530f685b87 100644 --- a/classes/zh_CN/class_light3d.rst +++ b/classes/zh_CN/class_light3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Light3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Light3D.xml. .. _class_Light3D: @@ -321,7 +321,7 @@ enum **BakeMode**: :ref:`🔗` :ref:`BakeMode` **BAKE_DISABLED** = ``0`` -烘焙时灯光将被忽略。这是最快的模式，但是在烘焙全局照明时仍会考虑该灯光。该模式通常应用于快速变化的动态灯光，因为全局照明的效果在这些灯光上不太明显。 +烘焙时灯光将被忽略。这是最快的模式，但是在烘焙全局照明时不会考虑该灯光。该模式通常应用于快速变化的动态灯光，因为全局照明的效果在这些灯光上不太明显。 \ **注意：**\ 将灯光隐藏，\ *不*\ 影响烘焙 :ref:`LightmapGI`\ 。但将灯光隐藏，仍会影响烘焙 :ref:`VoxelGI` 和 SDFGI（请参阅 :ref:`Environment.sdfgi_enabled`\ ）。 @@ -477,7 +477,7 @@ enum **BakeMode**: :ref:`🔗` - |void| **set_bake_mode**\ (\ value\: :ref:`BakeMode`\ ) - :ref:`BakeMode` **get_bake_mode**\ (\ ) -灯光的烘焙模式。会影响对灯光渲染有影响的全局照明技术。见 :ref:`BakeMode`\ 。 +灯光的烘焙模式。会影响对灯光渲染有影响的全局照明技术。 \ **注意：**\ 网格的全局照明模式也会影响全局照明渲染。见 :ref:`GeometryInstance3D.gi_mode`\ 。 @@ -496,7 +496,7 @@ enum **BakeMode**: :ref:`🔗` - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) -光的颜色。\ *过亮*\ 的颜色可用于实现与增加光的 :ref:`light_energy` 相等价的结果。 +光的颜色，使用非线性 sRGB 色彩空间。\ *过亮*\ 的颜色可用于实现与增加光的 :ref:`light_energy` 相等价的结果。 .. rst-class:: classref-item-separator @@ -885,6 +885,7 @@ enum **BakeMode**: :ref:`🔗` 设置指定的 :ref:`Param` 参数的值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightmapgi.rst b/classes/zh_CN/class_lightmapgi.rst index 920ad9eda6..83e41f8dfa 100644 --- a/classes/zh_CN/class_lightmapgi.rst +++ b/classes/zh_CN/class_lightmapgi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LightmapGI.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapGI.xml. .. _class_LightmapGI: @@ -749,6 +749,7 @@ enum **EnvironmentMode**: :ref:`🔗` \ **注意：**\ :ref:`use_texture_for_bounces` 仅在 :ref:`bounces` 被设置为大于或等于 ``1`` 的值时才有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightmapgidata.rst b/classes/zh_CN/class_lightmapgidata.rst index 7dc7d70fc7..8ebe5932a5 100644 --- a/classes/zh_CN/class_lightmapgidata.rst +++ b/classes/zh_CN/class_lightmapgidata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LightmapGIData.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapGIData.xml. .. _class_LightmapGIData: @@ -236,6 +236,7 @@ enum **ShadowmaskMode**: :ref:`🔗` \ **注意：**\ 在已烘焙的光照贴图上更改此值不会导致再次烘焙它们。这意味着在再次烘焙光照贴图之前，材质外观将看起来不正确，在这种情况下，此处设置的值将被丢弃，因为整个 **LightmapGIData** 资源被光照贴图器替换。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightmapper.rst b/classes/zh_CN/class_lightmapper.rst index 9041ccad46..3c8ddbb18f 100644 --- a/classes/zh_CN/class_lightmapper.rst +++ b/classes/zh_CN/class_lightmapper.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Lightmapper.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Lightmapper.xml. .. _class_Lightmapper: @@ -26,6 +26,7 @@ Lightmapper Godot 包含一个基于 GPU 的内置光照贴图器 :ref:`LightmapperRD`\ ，它使用计算着色器，但自定义光照贴图器可以由 C++ 模块实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightmapperrd.rst b/classes/zh_CN/class_lightmapperrd.rst index f6f44914bf..eb59c70eaa 100644 --- a/classes/zh_CN/class_lightmapperrd.rst +++ b/classes/zh_CN/class_lightmapperrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LightmapperRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapperRD.xml. .. _class_LightmapperRD: @@ -24,6 +24,7 @@ LightmapperRD（“RD”代表 :ref:`RenderingDevice`\ \ **注意：**\ 仅在使用 RenderingDevice 后端（Forward+ 或移动渲染器）时可用，使用 Compatibility 时不可用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightmapprobe.rst b/classes/zh_CN/class_lightmapprobe.rst index 937b195cc2..2fafbf7924 100644 --- a/classes/zh_CN/class_lightmapprobe.rst +++ b/classes/zh_CN/class_lightmapprobe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LightmapProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapProbe.xml. .. _class_LightmapProbe: @@ -26,6 +26,7 @@ LightmapProbe \ **注意：**\ 烘焙光照贴图后放置的 **LightmapProbe** 节点会被动态对象忽略。必须在创建或修改 **LightmapProbe** 后再次烘焙光照贴图，以使探针生效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lightoccluder2d.rst b/classes/zh_CN/class_lightoccluder2d.rst index 9c0c73297f..236f1200a1 100644 --- a/classes/zh_CN/class_lightoccluder2d.rst +++ b/classes/zh_CN/class_lightoccluder2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LightOccluder2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightOccluder2D.xml. .. _class_LightOccluder2D: @@ -101,6 +101,7 @@ LightOccluder2D 的遮挡器光照掩码。LightOccluder2D 将仅从具有相同 如果启用，该遮挡器将成为实时生成的带符号距离场的一部分，可被用于自定义着色器中。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_line2d.rst b/classes/zh_CN/class_line2d.rst index 749f8484c0..20dbb88f3a 100644 --- a/classes/zh_CN/class_line2d.rst +++ b/classes/zh_CN/class_line2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Line2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Line2D.xml. .. _class_Line2D: @@ -240,7 +240,7 @@ enum **LineTextureMode**: :ref:`🔗` - |void| **set_begin_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) - :ref:`LineCapMode` **get_begin_cap_mode**\ (\ ) -:ref:`closed` 为 ``false`` 时的折线开头样式。使用 :ref:`LineCapMode` 常量。 +:ref:`closed` 为 ``false`` 时的折线开头样式。 .. rst-class:: classref-item-separator @@ -295,7 +295,7 @@ enum **LineTextureMode**: :ref:`🔗` - |void| **set_end_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) - :ref:`LineCapMode` **get_end_cap_mode**\ (\ ) -:ref:`closed` 为 ``false`` 时的折线末端样式。使用 :ref:`LineCapMode` 常量。 +:ref:`closed` 为 ``false`` 时的折线末端样式。 .. rst-class:: classref-item-separator @@ -329,7 +329,7 @@ enum **LineTextureMode**: :ref:`🔗` - |void| **set_joint_mode**\ (\ value\: :ref:`LineJointMode`\ ) - :ref:`LineJointMode` **get_joint_mode**\ (\ ) -折线段之间的连接样式。使用 :ref:`LineJointMode` 常量。 +折线段之间的连接样式。 .. rst-class:: classref-item-separator @@ -416,7 +416,7 @@ enum **LineTextureMode**: :ref:`🔗` - |void| **set_texture_mode**\ (\ value\: :ref:`LineTextureMode`\ ) - :ref:`LineTextureMode` **get_texture_mode**\ (\ ) -渲染该折线的 :ref:`texture` 的样式。使用 :ref:`LineTextureMode` 常量。 +渲染该折线的 :ref:`texture` 的样式。 .. rst-class:: classref-item-separator @@ -532,6 +532,7 @@ enum **LineTextureMode**: :ref:`🔗` 用提供的 ``position`` 覆盖给定索引 ``index`` 处的点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_lineedit.rst b/classes/zh_CN/class_lineedit.rst index 125ba5232a..aecc34131f 100644 --- a/classes/zh_CN/class_lineedit.rst +++ b/classes/zh_CN/class_lineedit.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LineEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LineEdit.xml. .. _class_LineEdit: @@ -32,6 +32,14 @@ LineEdit - 详见 :ref:`edit()`\ 、\ :ref:`unedit()`\ 、\ :ref:`is_editing()`\ 、\ :ref:`editing_toggled`\ 。 +输入文本时，可以使用 Unicode、OEM、Windows Alt 代码来插入特殊字符： + +- 输入 Unicode 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （U+00E1），请按住 :kbd:`Alt` 并使用小键盘输入 :kbd:`+E1`\ （前置的零可以省略）。 + +- 输入 OEM 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （OEM 160），请按住 :kbd:`Alt` 并使用小键盘输入 ``160``\ 。 + +- 输入 Windows 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （Windows 0225）请按住 :kbd:`Alt` 并使用小键盘输入 :kbd:`0`\ 、\ :kbd:`2`\ 、\ :kbd:`2`\ 、\ :kbd:`5` 。前置的零\ **不能**\ 省略，因为 Windows 码位需要用这些零来和 OEM 码位进行区分。 + \ **重要：**\ - 通过 ``ui_focus_next``\ （默认为 :kbd:`Tab`\ ）、\ ``ui_focus_prev``\ （默认为 :kbd:`Shift + Tab`\ ）或 :ref:`Control.grab_focus()` 聚焦 **LineEdit** 仍然会进入编辑模式（出于兼容考虑）。 @@ -90,75 +98,79 @@ LineEdit .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_blink` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`caret_column` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_force_displayed` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clear_button_enabled` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`drag_and_drop_selection_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editable` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`expand_to_text_length` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`flat` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`keep_editing_on_text_submit` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`language` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_length` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | mouse_default_cursor_shape | ``1`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`placeholder_text` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`right_icon` | | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`secret` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`secret_character` | ``"•"`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`selecting_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shortcut_keys_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`text` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`VirtualKeyboardType` | :ref:`virtual_keyboard_type` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`backspace_deletes_composite_character_enabled` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_blink` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`caret_column` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_force_displayed` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clear_button_enabled` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`drag_and_drop_selection_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editable` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`expand_to_text_length` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`flat` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`keep_editing_on_text_submit` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_length` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | mouse_default_cursor_shape | ``1`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`placeholder_text` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`right_icon` | | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`secret` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`secret_character` | ``"•"`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`selecting_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shortcut_keys_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_show_on_focus` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`VirtualKeyboardType` | :ref:`virtual_keyboard_type` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -168,53 +180,57 @@ LineEdit .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`apply_ime`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cancel_ime`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`delete_char_at_caret`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`delete_text`\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`edit`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_scroll_offset`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_column`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_column`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selection`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editing`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ from\: :ref:`int` = 0, to\: :ref:`int` = -1\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select_all`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unedit`\ (\ ) | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_ime`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_ime`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_char_at_caret`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_text`\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`edit`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_composite_character_column`\ (\ column\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_previous_composite_character_column`\ (\ column\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_scroll_offset`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_column`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_column`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selection`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editing`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ from\: :ref:`int` = 0, to\: :ref:`int` = -1\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unedit`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -690,6 +706,23 @@ enum **VirtualKeyboardType**: :ref:`🔗` ---- +.. _class_LineEdit_property_backspace_deletes_composite_character_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **backspace_deletes_composite_character_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_backspace_deletes_composite_character_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_backspace_deletes_composite_character_enabled**\ (\ ) + +如果为 ``true`` 且 :ref:`caret_mid_grapheme` 为 ``false``\ ，则退格键会删除完整的组合字符，例如 ❤️‍🩹，而不是删除组合字符中的一部分。 + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_property_caret_blink: .. rst-class:: classref-property @@ -1229,7 +1262,24 @@ enum **VirtualKeyboardType**: :ref:`🔗` - |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) -如果为 ``true``\ ，则在获得焦点时会在支持的平台上显示原生虚拟键盘。 +如果为 ``true``\ ，则会在支持的平台上启用原生虚拟键盘。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LineEdit_property_virtual_keyboard_show_on_focus: + +.. rst-class:: classref-property + +:ref:`bool` **virtual_keyboard_show_on_focus** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_virtual_keyboard_show_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_virtual_keyboard_show_on_focus**\ (\ ) + +如果为 ``true``\ ，则在收到获得焦点事件时会在支持的平台上显示原生虚拟键盘。 .. rst-class:: classref-item-separator @@ -1367,7 +1417,7 @@ enum **VirtualKeyboardType**: :ref:`🔗` menu.add_item("Insert Date", MENU_MAX + 1) # 连接回调。 menu.id_pressed.connect(_on_item_pressed) - + func _on_item_pressed(id): if id == MENU_MAX + 1: insert_text_at_caret(Time.get_date_string_from_system()) @@ -1385,7 +1435,7 @@ enum **VirtualKeyboardType**: :ref:`🔗` // 添加事件处理器。 menu.IdPressed += OnItemPressed; } - + public void OnItemPressed(int id) { if (id == LineEdit.MenuItems.Max + 1) @@ -1402,6 +1452,34 @@ enum **VirtualKeyboardType**: :ref:`🔗` ---- +.. _class_LineEdit_method_get_next_composite_character_column: + +.. rst-class:: classref-method + +:ref:`int` **get_next_composite_character_column**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` + +如果光标位于合成字符的开头，则返回该字符末尾所在的正确列。合成字符由多个 Unicode 码位组合而成（例如修复爱心 ❤️‍🩹 的 Unicode 为 ``U+2764 U+FE0F U+200D U+1FA79``\ ）。如果文本光标位于非合成字符字素的内部，也会返回正确的列。 + +\ **注意：**\ 请使用 ``get_next_composite_character_column(get_caret_column())`` 在文本光标的位置进行检查 + +.. rst-class:: classref-item-separator + +---- + +.. _class_LineEdit_method_get_previous_composite_character_column: + +.. rst-class:: classref-method + +:ref:`int` **get_previous_composite_character_column**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` + +如果光标位于合成字符的末尾，则返回该字符开头所在的正确列。合成字符由多个 Unicode 码位组合而成（例如修复爱心 ❤️‍🩹 的 Unicode 为 ``U+2764 U+FE0F U+200D U+1FA79``\ ）。如果文本光标位于非合成字符字素的内部，也会返回正确的列。 + +\ **注意：**\ 请使用 ``get_previous_composite_character_column(get_caret_column())`` 在文本光标的位置进行检查 + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_get_scroll_offset: .. rst-class:: classref-method @@ -1821,6 +1899,7 @@ enum **VirtualKeyboardType**: :ref:`🔗` 该 **LineEdit** 处于只读模式时使用的背景（\ :ref:`editable` 为 ``false``\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_linkbutton.rst b/classes/zh_CN/class_linkbutton.rst index 5e8e5e0d51..52e10ae633 100644 --- a/classes/zh_CN/class_linkbutton.rst +++ b/classes/zh_CN/class_linkbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LinkButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LinkButton.xml. .. _class_LinkButton: @@ -32,7 +32,7 @@ LinkButton :widths: auto +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -229,7 +229,7 @@ LinkButton 永远不会在其文本底部显示下划线。 - |void| **set_underline_mode**\ (\ value\: :ref:`UnderlineMode`\ ) - :ref:`UnderlineMode` **get_underline_mode**\ (\ ) -文本的下划线模式。可用模式见 :ref:`UnderlineMode`\ 。 +文本使用的下划线模式。 .. rst-class:: classref-item-separator @@ -417,6 +417,7 @@ LinkButton 永远不会在其文本底部显示下划线。 该 **LinkButton** 处于聚焦状态时使用的 :ref:`StyleBox`\ 。\ :ref:`focus` :ref:`StyleBox` 显示在基础 :ref:`StyleBox` *之上*\ ，所以应该使用部分透明的 :ref:`StyleBox`\ ，确保基础 :ref:`StyleBox` 仍然可见。代表轮廓或下划线的 :ref:`StyleBox` 可以很好地实现这个目的。要禁用聚焦的视觉效果，请指定 :ref:`StyleBoxEmpty` 资源。请注意，禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性，所以出于可访问性的原因，不建议这样做。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_logger.rst b/classes/zh_CN/class_logger.rst new file mode 100644 index 0000000000..aaf5824978 --- /dev/null +++ b/classes/zh_CN/class_logger.rst @@ -0,0 +1,132 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Logger.xml. + +.. _class_Logger: + +Logger +====== + +**继承：** :ref:`RefCounted` **<** :ref:`Object` + +自定义日志记录器，能够从内部错误/警告流接收消息。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +自定义日志记录器，能够从内部错误/警告流接收消息。日志记录器通过 :ref:`OS.add_logger()` 注册。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_log_error`\ (\ function\: :ref:`String`, file\: :ref:`String`, line\: :ref:`int`, code\: :ref:`String`, rationale\: :ref:`String`, editor_notify\: :ref:`bool`, error_type\: :ref:`int`, script_backtraces\: :ref:`Array`\[:ref:`ScriptBacktrace`\]\ ) |virtual| | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_log_message`\ (\ message\: :ref:`String`, error\: :ref:`bool`\ ) |virtual| | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_Logger_ErrorType: + +.. rst-class:: classref-enumeration + +enum **ErrorType**: :ref:`🔗` + +.. _class_Logger_constant_ERROR_TYPE_ERROR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ErrorType` **ERROR_TYPE_ERROR** = ``0`` + +接收到的消息是错误。 + +.. _class_Logger_constant_ERROR_TYPE_WARNING: + +.. rst-class:: classref-enumeration-constant + +:ref:`ErrorType` **ERROR_TYPE_WARNING** = ``1`` + +接收到的消息是警告。 + +.. _class_Logger_constant_ERROR_TYPE_SCRIPT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ErrorType` **ERROR_TYPE_SCRIPT** = ``2`` + +接收到的消息是脚本错误。 + +.. _class_Logger_constant_ERROR_TYPE_SHADER: + +.. rst-class:: classref-enumeration-constant + +:ref:`ErrorType` **ERROR_TYPE_SHADER** = ``3`` + +接收到的消息是着色器错误。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_Logger_private_method__log_error: + +.. rst-class:: classref-method + +|void| **_log_error**\ (\ function\: :ref:`String`, file\: :ref:`String`, line\: :ref:`int`, code\: :ref:`String`, rationale\: :ref:`String`, editor_notify\: :ref:`bool`, error_type\: :ref:`int`, script_backtraces\: :ref:`Array`\[:ref:`ScriptBacktrace`\]\ ) |virtual| :ref:`🔗` + +记录错误时调用。错误会提供对应的函数 ``function``\ 、文件 ``file``\ 、行号 ``line`` 等信息，以及错误码 ``code`` 或者解释信息 ``rationale``\ 。 + +错误类型由 ``error_type`` 提供，描述见 :ref:`ErrorType` 枚举。 + +此外，\ ``script_backtraces`` 还提供了各个脚本语言的追踪信息。默认情况下，只有在编辑器构建和调试构建中才会包含栈帧。如果在发布构建中也需要启用栈帧信息，请启用 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks`\ 。 + +\ **警告：**\ 该函数可能从多个不同的线程调用，你可能需要自行加锁。 + +\ **注意：**\ 由于开销过大，\ ``script_backtraces`` 中不包含捕获变量。如果要获取变量，就需要使用 :ref:`Engine.capture_script_backtraces()` 在 **Logger** 的虚函数中自行捕获追踪。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Logger_private_method__log_message: + +.. rst-class:: classref-method + +|void| **_log_message**\ (\ message\: :ref:`String`, error\: :ref:`bool`\ ) |virtual| :ref:`🔗` + +记录消息时调用。如果 ``error`` 为 ``true``\ ，则该消息本来是要发往 ``stderr`` 的。 + +\ **警告：**\ 该函数可能从多个不同的线程调用，你可能需要自行加锁。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_lookatmodifier3d.rst b/classes/zh_CN/class_lookatmodifier3d.rst index 71a88d8401..dc67b94d44 100644 --- a/classes/zh_CN/class_lookatmodifier3d.rst +++ b/classes/zh_CN/class_lookatmodifier3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/LookAtModifier3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LookAtModifier3D.xml. .. _class_LookAtModifier3D: @@ -641,11 +641,11 @@ enum **OriginFrom**: :ref:`🔗` - |void| **set_use_angle_limitation**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_using_angle_limitation**\ (\ ) -如果为 ``true`` 则会限制旋转的角度。有助于防止角色的脖子发生 360 度旋转。 +如果为 ``true`` 则会限制旋转量。例如，可以帮助防止角色的脖子发生 360 度旋转。 \ **注意：**\ 与 :ref:`AnimationTree` 混合一样，插值时会优先考虑 :ref:`Skeleton3D.get_bone_rest()`\ 。这意味着插值在某些情况下不会选择最短路径。 -\ **注意：**\ 某些 :ref:`transition_type` 可能会超出限制（例如 `Back`、`Elastic` 和 `Spring`）。如果在超出限制时发生插值，结果可能不会遵循骨骼的放松姿势。 +\ **注意：**\ 某些 :ref:`transition_type` 的取值可能会超出限制（例如 :ref:`Tween.TRANS_BACK`\ 、\ :ref:`Tween.TRANS_ELASTIC`\ 、\ :ref:`Tween.TRANS_SPRING`\ ）。如果在超出限制时发生插值，结果可能不会遵循骨骼的放松姿势。 .. rst-class:: classref-item-separator @@ -691,7 +691,7 @@ enum **OriginFrom**: :ref:`🔗` :ref:`bool` **is_interpolating**\ (\ ) |const| :ref:`🔗` -返回是否正在执行基于时间的插值。如果为 ``true``\ ，则等价于 :ref:`get_interpolation_remaining()` 为 ``0``\ 。 +如果正在执行基于时间的插值则返回 ``true``\ 。如果为 ``true``\ ，则等价于 :ref:`get_interpolation_remaining()` 返回 ``0.0``\ 。 适用于确定是否能够安全移除 **LookAtModifier3D**\ 。 @@ -710,6 +710,7 @@ enum **OriginFrom**: :ref:`🔗` \ **注意：**\ 该值在 :ref:`SkeletonModifier3D._process_modification()` 之后更新。为了获取正确的值，我们建议使用 :ref:`SkeletonModifier3D.modification_processed` 信号。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_mainloop.rst b/classes/zh_CN/class_mainloop.rst index e76cceba2f..d7473958a6 100644 --- a/classes/zh_CN/class_mainloop.rst +++ b/classes/zh_CN/class_mainloop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MainLoop.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MainLoop.xml. .. _class_MainLoop: @@ -34,18 +34,18 @@ MainLoop class_name CustomMainLoop extends MainLoop - + var time_elapsed = 0 - + func _initialize(): print("初始化：") print(" 开始时间：%s" % str(time_elapsed)) - + func _process(delta): time_elapsed += delta # 返回 true 结束主循环。 return Input.get_mouse_button_mask() != 0 || Input.is_key_pressed(KEY_ESCAPE) - + func _finalize(): print("完成：") print(" 结束时间：%s" % str(time_elapsed)) @@ -53,25 +53,25 @@ MainLoop .. code-tab:: csharp using Godot; - + [GlobalClass] public partial class CustomMainLoop : MainLoop { private double _timeElapsed = 0; - + public override void _Initialize() { GD.Print("初始化："); GD.Print($" 开始时间：{_timeElapsed}"); } - + public override bool _Process(double delta) { _timeElapsed += delta; // 返回 true 结束主循环。 return Input.GetMouseButtonMask() != 0 || Input.IsKeyPressed(Key.Escape); } - + private void _Finalize() { GD.Print("完成："); @@ -262,11 +262,13 @@ MainLoop :ref:`bool` **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` -每个物理帧调用一次，调用时会传入自上一个物理帧以来的时间作为参数（\ ``delta``\ ，单位为秒）。等价于 :ref:`Node._physics_process()`\ 。 +Called each physics tick. ``delta`` is the logical time between physics ticks in seconds and is equal to :ref:`Engine.time_scale` / :ref:`Engine.physics_ticks_per_second`. Equivalent to :ref:`Node._physics_process()`. -如果实现了该方法，则必须返回一个布尔值。返回 ``true`` 会结束主循环，而返回 ``false`` 则允许继续到下一帧。 +If implemented, the method must return a boolean value. ``true`` ends the main loop, while ``false`` lets it proceed to the next step. -\ **注意：**\ 如果运行的帧率低于 :ref:`Engine.physics_ticks_per_second` / :ref:`Engine.max_physics_steps_per_frame` FPS，则 ``delta`` 将会比预期的要大。这是为了避免发生“死亡螺旋”的情况，此时每帧的物理步骤数量会不断增加，导致性能急剧下降。这种行为会影响 :ref:`_process()` 和 :ref:`_physics_process()`\ 。因此，请避免根据 ``delta`` 来测量真实世界的秒数。请使用 :ref:`Time` 单例的方法来实现此目的，例如 :ref:`Time.get_ticks_usec()`\ 。 +\ **Note:** :ref:`_physics_process()` may be called up to :ref:`Engine.max_physics_steps_per_frame` times per (idle) frame. This step limit may be reached when the engine is suffering performance issues. + +\ **Note:** Accumulated ``delta`` may diverge from real world seconds. .. rst-class:: classref-item-separator @@ -278,13 +280,18 @@ MainLoop :ref:`bool` **_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` -每个处理（空闲）帧调用一次，调用时会传入自上一个处理帧以来的时间作为参数（\ ``delta``\ ，单位为秒）。等价于 :ref:`Node._process()`\ 。 +Called on each idle frame, prior to rendering, and after physics ticks have been processed. ``delta`` is the time between frames in seconds. Equivalent to :ref:`Node._process()`. -如果实现了该方法，则必须返回一个布尔值。返回 ``true`` 会结束主循环，而返回 ``false`` 则允许继续到下一帧。 +If implemented, the method must return a boolean value. ``true`` ends the main loop, while ``false`` lets it proceed to the next frame. -\ **注意：**\ 如果运行的帧率低于 :ref:`Engine.physics_ticks_per_second` / :ref:`Engine.max_physics_steps_per_frame` FPS，则 ``delta`` 将会比预期的要大。这是为了避免发生“死亡螺旋”的情况，此时每帧的物理步骤数量会不断增加，导致性能急剧下降。这种行为会影响 :ref:`_process()` 和 :ref:`_physics_process()`\ 。因此，请避免根据 ``delta`` 来测量真实世界的秒数。请使用 :ref:`Time` 单例的方法来实现此目的，例如 :ref:`Time.get_ticks_usec()`\ 。 +\ **Note:** When the engine is struggling and the frame rate is lowered, ``delta`` will increase. When ``delta`` is increased, it's capped at a maximum of :ref:`Engine.time_scale` \* :ref:`Engine.max_physics_steps_per_frame` / :ref:`Engine.physics_ticks_per_second`. As a result, accumulated ``delta`` may not represent real world time. + +\ **Note:** When ``--fixed-fps`` is enabled or the engine is running in Movie Maker mode (see :ref:`MovieWriter`), process ``delta`` will always be the same for every frame, regardless of how much time the frame took to render. + +\ **Note:** Frame delta may be post-processed by :ref:`OS.delta_smoothing` if this is enabled for the project. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_margincontainer.rst b/classes/zh_CN/class_margincontainer.rst index 28a2db2f96..a3fe013870 100644 --- a/classes/zh_CN/class_margincontainer.rst +++ b/classes/zh_CN/class_margincontainer.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MarginContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MarginContainer.xml. .. _class_MarginContainer: @@ -128,6 +128,7 @@ MarginContainer 从顶部向容器的内部直接子项偏移一定量的像素。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_marker2d.rst b/classes/zh_CN/class_marker2d.rst index 698f1ff221..9559543cf3 100644 --- a/classes/zh_CN/class_marker2d.rst +++ b/classes/zh_CN/class_marker2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Marker2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marker2D.xml. .. _class_Marker2D: @@ -56,6 +56,7 @@ Marker2D 出现在编辑器中的小工具十字的大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_marker3d.rst b/classes/zh_CN/class_marker3d.rst index 439dccc7d0..be2b89e399 100644 --- a/classes/zh_CN/class_marker3d.rst +++ b/classes/zh_CN/class_marker3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Marker3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marker3D.xml. .. _class_Marker3D: @@ -56,6 +56,7 @@ Marker3D 出现在编辑器中的小工具十字的大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_marshalls.rst b/classes/zh_CN/class_marshalls.rst index fac3ae8a99..a0dd70fb9e 100644 --- a/classes/zh_CN/class_marshalls.rst +++ b/classes/zh_CN/class_marshalls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Marshalls.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marshalls.xml. .. _class_Marshalls: @@ -127,6 +127,7 @@ Marshalls 内部实现时，使用的编码机制与 :ref:`@GlobalScope.var_to_bytes()` 方法相同。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_material.rst b/classes/zh_CN/class_material.rst index 0d224bcf74..ee55570e6e 100644 --- a/classes/zh_CN/class_material.rst +++ b/classes/zh_CN/class_material.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Material.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Material.xml. .. _class_Material: @@ -61,9 +61,9 @@ Material +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_use_render_priority`\ (\ ) |virtual| |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Mode` | :ref:`_get_shader_mode`\ (\ ) |virtual| |const| | + | :ref:`Mode` | :ref:`_get_shader_mode`\ (\ ) |virtual| |required| |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_shader_rid`\ (\ ) |virtual| |const| | + | :ref:`RID` | :ref:`_get_shader_rid`\ (\ ) |virtual| |required| |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ @@ -136,7 +136,7 @@ Material - |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_render_priority**\ (\ ) -设置 3D 场景中物体的渲染优先级。优先级高的物体将被排序在优先级低的物体前面。换句话说，所有具有 :ref:`render_priority` ``1`` 的对象，将在所有具有 :ref:`render_priority` ``0`` 的对象之前渲染。 +设置 3D 场景中物体的渲染优先级。优先级高的物体将被排序在优先级低的物体前面。换句话说，所有具有 :ref:`render_priority` ``1`` 的对象，将在所有具有 :ref:`render_priority` ``0`` 的对象之上渲染。 \ **注意：**\ 仅适用于 :ref:`StandardMaterial3D` 和“Spatial”类型的 :ref:`ShaderMaterial`\ 。 @@ -179,7 +179,7 @@ Material .. rst-class:: classref-method -:ref:`Mode` **_get_shader_mode**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Mode` **_get_shader_mode**\ (\ ) |virtual| |required| |const| :ref:`🔗` 仅出于覆盖目的而暴露。你不能直接调用该函数。由各种编辑器工具内部使用。 @@ -191,7 +191,7 @@ Material .. rst-class:: classref-method -:ref:`RID` **_get_shader_rid**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_get_shader_rid**\ (\ ) |virtual| |required| |const| :ref:`🔗` 仅出于覆盖目的而暴露。你不能直接调用该函数。由各种编辑器工具内部使用。用于访问 **Material** 的 :ref:`Shader` 的 RID。 @@ -220,6 +220,7 @@ Material 仅在编辑器中运行时可用。打开一个弹出窗口显示生成的着色器代码，包括所有变体和内部着色器代码。另见 :ref:`Shader.inspect_native_shader_code()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_menubar.rst b/classes/zh_CN/class_menubar.rst index 25175ff55b..5febd22148 100644 --- a/classes/zh_CN/class_menubar.rst +++ b/classes/zh_CN/class_menubar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MenuBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuBar.xml. .. _class_MenuBar: @@ -29,19 +29,21 @@ MenuBar .. table:: :widths: auto - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`flat` | ``false`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`language` | ``""`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`prefer_global_menu` | ``true`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`start_index` | ``-1`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`switch_on_hover` | ``true`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`flat` | ``false`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`prefer_global_menu` | ``true`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`start_index` | ``-1`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`switch_on_hover` | ``true`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -649,6 +651,7 @@ MenuBar 菜单项处于按下状态时使用的 :ref:`StyleBox`\ （用于从右至左布局）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_menubutton.rst b/classes/zh_CN/class_menubutton.rst index b59613a094..6bdf8dd010 100644 --- a/classes/zh_CN/class_menubutton.rst +++ b/classes/zh_CN/class_menubutton.rst @@ -1,9 +1,12 @@ :github_url: hide +.. meta:: + :keywords: dropdown + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MenuButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuButton.xml. .. _class_MenuButton: @@ -36,7 +39,7 @@ MenuButton +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | flat | ``true`` (overrides :ref:`Button`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`item_count` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -161,6 +164,7 @@ MenuButton 调整该 **MenuButton** 的弹出位置和大小，然后显示该 :ref:`PopupMenu`\ 。请优先使用此方法，而不是使用 ``get_popup().popup()``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_mesh.rst b/classes/zh_CN/class_mesh.rst index ece6e4c043..652ba30d07 100644 --- a/classes/zh_CN/class_mesh.rst +++ b/classes/zh_CN/class_mesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Mesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Mesh.xml. .. _class_Mesh: @@ -56,59 +56,59 @@ Mesh .. table:: :widths: auto - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_get_aabb`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_blend_shape_count`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_blend_shape_name`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_surface_count`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_blend_shape_name`\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_array_index_len`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_array_len`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_surface_get_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Array`\] | :ref:`_surface_get_blend_shape_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_format`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_surface_get_lods`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`_surface_get_material`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_primitive_type`\ (\ index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_surface_set_material`\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConvexPolygonShape3D` | :ref:`create_convex_shape`\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mesh` | :ref:`create_outline`\ (\ margin\: :ref:`float`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConcavePolygonShape3D` | :ref:`create_trimesh_shape`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_count`\ (\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`surface_get_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Array`\] | :ref:`surface_get_blend_shape_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`surface_get_material`\ (\ surf_idx\: :ref:`int`\ ) |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`surface_set_material`\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_get_aabb`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_blend_shape_count`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_blend_shape_name`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_surface_count`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_blend_shape_name`\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| |required| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_array_index_len`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_array_len`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_surface_get_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`_surface_get_blend_shape_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_format`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_surface_get_lods`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`_surface_get_material`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_primitive_type`\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_surface_set_material`\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| |required| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConvexPolygonShape3D` | :ref:`create_convex_shape`\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Mesh` | :ref:`create_outline`\ (\ margin\: :ref:`float`\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConcavePolygonShape3D` | :ref:`create_trimesh_shape`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_count`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`surface_get_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`surface_get_blend_shape_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`surface_get_material`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_material`\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -573,7 +573,7 @@ flags **ArrayFormat**: :ref:`🔗` :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` -网格数据将在 GLES 上使用 ``GL_DYNAMIC_DRAW`` 的标记索引。在 Vulkan 上未被使用。 +用于标记网格数据将在 GLES 上使用 ``GL_DYNAMIC_DRAW`` 的标志。在 Vulkan 上不使用。 .. _class_Mesh_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: @@ -660,7 +660,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖 :ref:`AABB`\ 。 @@ -672,7 +672,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_blend_shape_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_blend_shape_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖混合形状的数量。 @@ -684,7 +684,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`StringName` **_get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`StringName` **_get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖混合形状名称的获取过程。 @@ -696,7 +696,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_surface_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_surface_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面的数量。 @@ -708,7 +708,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **_set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| :ref:`🔗` +|void| **_set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| |required| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖混合形状的名称。 @@ -720,7 +720,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_surface_get_array_index_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_surface_get_array_index_len**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面数组索引的长度。 @@ -732,7 +732,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_surface_get_array_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_surface_get_array_len**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面数组的长度。 @@ -744,7 +744,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array` **_surface_get_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array` **_surface_get_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面数组。 @@ -756,7 +756,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Array`\] **_surface_get_blend_shape_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Array`\] **_surface_get_blend_shape_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖混合形状数组。 @@ -768,7 +768,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_surface_get_format**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_surface_get_format**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面格式。 @@ -780,7 +780,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Dictionary` **_surface_get_lods**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_surface_get_lods**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面 LOD。 @@ -792,7 +792,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Material` **_surface_get_material**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Material` **_surface_get_material**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面材质。 @@ -804,7 +804,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_surface_get_primitive_type**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_surface_get_primitive_type**\ (\ index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖表面图元类型。 @@ -816,7 +816,7 @@ enum **BlendShapeMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **_surface_set_material**\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| :ref:`🔗` +|void| **_surface_set_material**\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| |required| :ref:`🔗` 虚方法，能够为扩展自 **Mesh** 的自定义类覆盖索引为 ``index`` 的材质 ``material`` 的设置。 @@ -977,6 +977,7 @@ enum **BlendShapeMode**: :ref:`🔗` \ **注意：**\ 这会分配 **Mesh** 资源中的材质，而不是与 :ref:`MeshInstance3D` 的表面材质覆盖属性关联的 :ref:`Material`\ 。要设置与 :ref:`MeshInstance3D` 的表面材质覆盖属性关联的 :ref:`Material`\ ，请改用 :ref:`MeshInstance3D.set_surface_override_material()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshconvexdecompositionsettings.rst b/classes/zh_CN/class_meshconvexdecompositionsettings.rst index df37164e7f..33aeafec28 100644 --- a/classes/zh_CN/class_meshconvexdecompositionsettings.rst +++ b/classes/zh_CN/class_meshconvexdecompositionsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshConvexDecompositionSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshConvexDecompositionSettings.xml. .. _class_MeshConvexDecompositionSettings: @@ -315,6 +315,7 @@ enum **Mode**: :ref:`🔗` 控制对沿对称平面裁剪的偏置。范围从 ``0.0`` 到 ``1.0`` 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshdatatool.rst b/classes/zh_CN/class_meshdatatool.rst index 0e0a808123..491936226d 100644 --- a/classes/zh_CN/class_meshdatatool.rst +++ b/classes/zh_CN/class_meshdatatool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshDataTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshDataTool.xml. .. _class_MeshDataTool: @@ -254,9 +254,9 @@ MeshDataTool 提供对 :ref:`Mesh` 中各个顶点的访问。它允 :ref:`int` **get_edge_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| :ref:`🔗` -返回连接到给定边的指定顶点的索引。 +返回连接到索引为 ``idx`` 的边的顶点 ``vertex`` 的索引。 -顶点参数只能是 0 或 1，因为边是由两个顶点组成的。 +\ ``vertex`` 只能是 ``0`` 或 ``1``\ ，因为一条边由两个顶点组成。 .. rst-class:: classref-item-separator @@ -280,9 +280,9 @@ MeshDataTool 提供对 :ref:`Mesh` 中各个顶点的访问。它允 :ref:`int` **get_face_edge**\ (\ idx\: :ref:`int`, edge\: :ref:`int`\ ) |const| :ref:`🔗` -返回与给定面关联的指定边。 +返回与索引为 ``idx`` 的面相关联的边。 -边参数必须是 0、1、2 之一，因为面只有 3 条边。 +\ ``edge`` 参数只能是 ``0``\ 、\ ``1`` 或 ``2``\ ，因为一个面只有三条边。 .. rst-class:: classref-item-separator @@ -652,6 +652,7 @@ MeshDataTool 提供对 :ref:`Mesh` 中各个顶点的访问。它允 设置给定顶点的骨骼权重。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshinstance2d.rst b/classes/zh_CN/class_meshinstance2d.rst index a64df2e00b..07146df326 100644 --- a/classes/zh_CN/class_meshinstance2d.rst +++ b/classes/zh_CN/class_meshinstance2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshInstance2D.xml. .. _class_MeshInstance2D: @@ -99,6 +99,7 @@ MeshInstance2D 使用默认 :ref:`CanvasItemMaterial` 时，将使用的 :ref:`Texture2D`\ 。可以在 CanvasItem 着色器中作为 ``TEXTURE`` 访问。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshinstance3d.rst b/classes/zh_CN/class_meshinstance3d.rst index 708507d63d..04aa1d2db5 100644 --- a/classes/zh_CN/class_meshinstance3d.rst +++ b/classes/zh_CN/class_meshinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshInstance3D.xml. .. _class_MeshInstance3D: @@ -21,7 +21,7 @@ MeshInstance3D 描述 ---- -MeshInstance3D 节点接受 :ref:`Mesh` 资源，会为该网格创建一个实例，将其添加到当前的场景中。这是渲染 3D 几何体时最常用的类，可以将单个 :ref:`Mesh` 在不同的地方实例化。这样就能够实现几何体的复用，节省资源。如果需要在比较集中的区域内将某个 :ref:`Mesh` 实例化超过几千次，请考虑改为在 :ref:`MultiMeshInstance3D` 中使用 :ref:`MultiMesh`\ 。 +MeshInstance3D 节点接受 :ref:`Mesh` 资源，会为该网格创建一个实例并将该实例添加到当前的场景中。最常用于渲染 3D 几何体，可以将单个 :ref:`Mesh` 在不同的地方实例化。这样就能够实现几何体的复用，从而节省资源。如果需要在比较集中的区域内将某个 :ref:`Mesh` 实例化超过几千次，请考虑改为在 :ref:`MultiMeshInstance3D` 中使用 :ref:`MultiMesh`\ 。 .. rst-class:: classref-introduction-group @@ -348,6 +348,7 @@ MeshInstance3D 节点接受 :ref:`Mesh` 资源，会为该网格创 \ **注意：**\ 这将分配与 **MeshInstance3D** 的表面材质覆盖属性关联的 :ref:`Material`\ ，而不是 :ref:`Mesh` 资源内的材质。要在 :ref:`Mesh` 资源中设置材质，请改用 :ref:`Mesh.surface_set_material()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshlibrary.rst b/classes/zh_CN/class_meshlibrary.rst index 051578195d..5f70f6099c 100644 --- a/classes/zh_CN/class_meshlibrary.rst +++ b/classes/zh_CN/class_meshlibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshLibrary.xml. .. _class_MeshLibrary: @@ -165,7 +165,7 @@ MeshLibrary :ref:`ShadowCastingSetting` **get_item_mesh_cast_shadow**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` -返回项目的阴影投射模式。可能的取值见 :ref:`ShadowCastingSetting`\ 。 +返回该项的阴影投射模式。 .. rst-class:: classref-item-separator @@ -299,7 +299,7 @@ MeshLibrary |void| **set_item_mesh_cast_shadow**\ (\ id\: :ref:`int`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) :ref:`🔗` -设置该项的阴影投射模式。可能的取值见 :ref:`ShadowCastingSetting`\ 。 +将该项的阴影投射模式设置为 ``shadow_casting_setting``\ 。 .. rst-class:: classref-item-separator @@ -390,6 +390,7 @@ MeshLibrary 该数组应由 :ref:`Shape3D` 对象组成，每个对象后跟一个将应用于它的 :ref:`Transform3D`\ 。对于不应具有变换的形状，请使用 :ref:`Transform3D.IDENTITY`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_meshtexture.rst b/classes/zh_CN/class_meshtexture.rst index 797ed86306..6951286cb7 100644 --- a/classes/zh_CN/class_meshtexture.rst +++ b/classes/zh_CN/class_meshtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MeshTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshTexture.xml. .. _class_MeshTexture: @@ -96,6 +96,7 @@ MeshTexture 设置用于绘制的网格，该网格必须使用 2D 顶点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_methodtweener.rst b/classes/zh_CN/class_methodtweener.rst index 75921c3ad4..bbeb84e274 100644 --- a/classes/zh_CN/class_methodtweener.rst +++ b/classes/zh_CN/class_methodtweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MethodTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MethodTweener.xml. .. _class_MethodTweener: @@ -83,6 +83,7 @@ MethodTweener 设置所使用的过渡类型 :ref:`TransitionType`\ 。如果没有设置，则使用包含这个 Tweener 的 :ref:`Tween` 的默认过渡类型。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_missingnode.rst b/classes/zh_CN/class_missingnode.rst index deb33618e7..c047752c67 100644 --- a/classes/zh_CN/class_missingnode.rst +++ b/classes/zh_CN/class_missingnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MissingNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MissingNode.xml. .. _class_MissingNode: @@ -96,6 +96,7 @@ MissingNode 如果为 ``true``\ ，则允许将新属性与已有属性一起设置。如果为 ``false``\ ，则只能设置已有属性的值，并且无法添加新属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_missingresource.rst b/classes/zh_CN/class_missingresource.rst index dc5857590d..be1343335a 100644 --- a/classes/zh_CN/class_missingresource.rst +++ b/classes/zh_CN/class_missingresource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MissingResource.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MissingResource.xml. .. _class_MissingResource: @@ -77,6 +77,7 @@ MissingResource 如果设置为 ``true``\ ，则允许使用 :ref:`Object.set()` 在已有属性之上添加新属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_mobilevrinterface.rst b/classes/zh_CN/class_mobilevrinterface.rst index 48cf597771..7f0c802e18 100644 --- a/classes/zh_CN/class_mobilevrinterface.rst +++ b/classes/zh_CN/class_mobilevrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/mobile_vr/doc_classes/MobileVRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/mobile_vr/doc_classes/MobileVRInterface.xml. .. _class_MobileVRInterface: @@ -245,6 +245,7 @@ k2 镜头因子，见 k1。 \ **注意：**\ 仅限 Mobile 和 Forward+ 渲染器。需要将 :ref:`Viewport.vrs_mode` 设置为 :ref:`Viewport.VRS_XR`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_modifierbonetarget3d.rst b/classes/zh_CN/class_modifierbonetarget3d.rst new file mode 100644 index 0000000000..880280e43c --- /dev/null +++ b/classes/zh_CN/class_modifierbonetarget3d.rst @@ -0,0 +1,87 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ModifierBoneTarget3D.xml. + +.. _class_ModifierBoneTarget3D: + +ModifierBoneTarget3D +==================== + +**继承：** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +动态复制父级 :ref:`Skeleton3D` 中某个骨骼 3D 变换的节点。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +这个节点能够选择 :ref:`Skeleton3D` 中的某个骨骼并附加到这个骨骼上。这样 **ModifierBoneTarget3D** 节点就能够动态复制所选骨骼的 3D 变换。 + +功能类似于 :ref:`BoneAttachment3D`\ ，但是这个节点使用 :ref:`SkeletonModifier3D` 的周期，适合作为其他 :ref:`SkeletonModifier3D` 的目标。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------------+-----------------------------------------------------------------+--------+ + | :ref:`int` | :ref:`bone` | ``-1`` | + +-----------------------------+-----------------------------------------------------------------+--------+ + | :ref:`String` | :ref:`bone_name` | ``""`` | + +-----------------------------+-----------------------------------------------------------------+--------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_ModifierBoneTarget3D_property_bone: + +.. rst-class:: classref-property + +:ref:`int` **bone** = ``-1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_bone**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bone**\ (\ ) + +所附着骨骼的索引。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ModifierBoneTarget3D_property_bone_name: + +.. rst-class:: classref-property + +:ref:`String` **bone_name** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_bone_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_bone_name**\ (\ ) + +所附着骨骼的名称。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_moviewriter.rst b/classes/zh_CN/class_moviewriter.rst index 5c28746fa5..23ef0b832a 100644 --- a/classes/zh_CN/class_moviewriter.rst +++ b/classes/zh_CN/class_moviewriter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MovieWriter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MovieWriter.xml. .. _class_MovieWriter: @@ -21,9 +21,11 @@ MovieWriter Godot 能够使用非实时模拟技术录制视频。与 ``--fixed-fps`` :doc:`命令行参数 <../tutorials/editor/command_line_tutorial>`\ 类似，会强制让 :ref:`Node._process()` 等函数每一帧都收到相同的 ``delta``\ ，无论实际渲染花费了多长的时间。这个技术可用于录制高画质的视频，无论你的硬件性能如何，帧率始终都是恒定的。 -Godot 内置的 **MovieWriter** 有两个： +Godot 内置的 **MovieWriter** 有 3 个： -- 使用 MJPEG 视频和未压缩音频的 AVI 容器（文件扩展名为 ``.avi``\ ）。有损压缩、文件大小中等、编码速度较快。有损压缩质量可以通过修改 :ref:`ProjectSettings.editor/movie_writer/mjpeg_quality` 来调整。生成的文件可以使用大多数视频播放器查看，但如果要在 Web 上查看或者用 Godot 的 :ref:`VideoStreamPlayer` 查看，则必须先进行格式的转换。MJPEG 不支持透明度。AVI 输出的文件目前最多为 4 GB 大小。 +- 使用 Theora 视频和 Vorbis 音频的 OVG 容器（文件扩展名为 ``.ogv``\ ）。有损压缩、文件大小中等、编码速度快。有损压缩质量可以通过修改 :ref:`ProjectSettings.editor/movie_writer/video_quality` 和 :ref:`ProjectSettings.editor/movie_writer/ogv/audio_quality` 来调整。生成的文件在 Godot 中可以使用 :ref:`VideoStreamPlayer` 查看，也可以使用大多数视频播放器查看，但是无法在网页浏览器中查看，因为它们不支持 Theora。 + +- 使用 MJPEG 视频和未压缩音频的 AVI 容器（文件扩展名为 ``.avi``\ ）。有损压缩、文件大小中等、编码速度较快。有损压缩质量可以通过修改 :ref:`ProjectSettings.editor/movie_writer/video_quality` 来调整。生成的文件可以使用大多数视频播放器查看，但如果要在 Web 上查看或者用 Godot 的 :ref:`VideoStreamPlayer` 查看，则必须先进行格式的转换。MJPEG 不支持透明度。AVI 输出的文件目前最多为 4 GB 大小。 - 视频使用 PNG 图像序列、音频使用 WAV（文件扩展名为 ``.png``\ ）。无损压缩、文件大小较大、编码速度较慢。旨在录制后使用 `FFmpeg `__ 等其他工具编码为视频文件。目前不支持透明度，即便将根视口设为透明。 @@ -33,6 +35,10 @@ Godot 内置的 **MovieWriter** 有两个： \ **注意：**\ MovieWriter 既可以在编辑器中使用，也可以在导出的项目中使用，但这个功能\ *不应*\ 用来让最终用户录制游戏视频。希望录制游戏视频的玩家应该安装 `OBS Studio `__ 或 `SimpleScreenRecorder `__ 等工具。 +\ **注意：**\ MJPEG 支持（(``.avi`` 文件扩展名）依赖于 ``jpg`` 模块，需要在编译时启用（默认行为）。 + +\ **注意：**\ OGV 支持（(``.ogv`` 文件扩展名）依赖于 ``theora`` 模块，需要在编译时启用（默认行为）。Theora 压缩仅在编辑器二进制文件中可用。 + .. rst-class:: classref-reftable-group 方法 @@ -41,21 +47,21 @@ Godot 内置的 **MovieWriter** 有两个： .. table:: :widths: auto - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_audio_mix_rate`\ (\ ) |virtual| |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SpeakerMode` | :ref:`_get_audio_speaker_mode`\ (\ ) |virtual| |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles_file`\ (\ path\: :ref:`String`\ ) |virtual| |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_write_begin`\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_write_end`\ (\ ) |virtual| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_write_frame`\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_writer`\ (\ writer\: :ref:`MovieWriter`\ ) |static| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_audio_mix_rate`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SpeakerMode` | :ref:`_get_audio_speaker_mode`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles_file`\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_write_begin`\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| |required| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_write_end`\ (\ ) |virtual| |required| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_write_frame`\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| |required| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_writer`\ (\ writer\: :ref:`MovieWriter`\ ) |static| | + +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +76,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -:ref:`int` **_get_audio_mix_rate**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_audio_mix_rate**\ (\ ) |virtual| |required| |const| :ref:`🔗` 当引擎请求用于录制音频的音频采样率时调用。返回的值必须以 Hz 为单位指定。如果 :ref:`_get_audio_mix_rate()` 未被重写，则默认为 48000 Hz。 @@ -82,7 +88,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -:ref:`SpeakerMode` **_get_audio_speaker_mode**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`SpeakerMode` **_get_audio_speaker_mode**\ (\ ) |virtual| |required| |const| :ref:`🔗` 当引擎请求用于录制音频的音频扬声器模式时调用。这可能会影响生成的音频文件/流中的输出通道数。如果 :ref:`_get_audio_speaker_mode()` 未被重写，则默认为 :ref:`AudioServer.SPEAKER_MODE_STEREO`\ 。 @@ -94,7 +100,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -:ref:`bool` **_handles_file**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_handles_file**\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` 当引擎确定该 **MovieWriter** 是否能够处理位于 ``path`` 的文件时调用。如果该 **MovieWriter** 能够处理给定的文件路径，则必须返回 ``true``\ ，否则返回 ``false``\ 。通常，\ :ref:`_handles_file()` 如下被重写，以允许用户使用给定文件扩展名，在任何路径下记录一个文件： @@ -113,7 +119,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -:ref:`Error` **_write_begin**\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| :ref:`🔗` +:ref:`Error` **_write_begin**\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` 在引擎开始写入视频和音频数据之前调用一次。\ ``movie_size`` 是要保存的视频的宽度和高度。\ ``fps`` 是指定的每秒帧数，在项目设置中或使用 ``--fixed-fps ``\ :doc:`《命令行参数》 <../tutorials/editor/command_line_tutorial>`\ 指定。 @@ -125,7 +131,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -|void| **_write_end**\ (\ ) |virtual| :ref:`🔗` +|void| **_write_end**\ (\ ) |virtual| |required| :ref:`🔗` 当引擎完成写入时调用。当引擎通过按下窗口管理器的关闭按钮退出时，或调用 :ref:`SceneTree.quit()` 时，会发生这种情况。 @@ -139,7 +145,7 @@ Godot 内置的 **MovieWriter** 有两个： .. rst-class:: classref-method -:ref:`Error` **_write_frame**\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| :ref:`🔗` +:ref:`Error` **_write_frame**\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| |required| :ref:`🔗` 在每个渲染的帧结束时被调用。应写入 ``frame_image`` 和 ``audio_frame_block`` 函数参数。 @@ -158,6 +164,7 @@ Godot 内置的 **MovieWriter** 有两个： \ **注意：**\ :ref:`add_writer()` 必须在引擎初始化期间尽早调用才能工作，因为电影编写被设计为与引擎的其余部分同时启动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multimesh.rst b/classes/zh_CN/class_multimesh.rst index 191fcb9909..536762e9c3 100644 --- a/classes/zh_CN/class_multimesh.rst +++ b/classes/zh_CN/class_multimesh.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMesh.xml. .. _class_MultiMesh: @@ -558,6 +558,7 @@ enum **PhysicsInterpolationQuality**: :ref:`🔗`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multimeshinstance2d.rst b/classes/zh_CN/class_multimeshinstance2d.rst index 1c9ff32b19..d8dd6fe844 100644 --- a/classes/zh_CN/class_multimeshinstance2d.rst +++ b/classes/zh_CN/class_multimeshinstance2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiMeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMeshInstance2D.xml. .. _class_MultiMeshInstance2D: @@ -97,6 +97,7 @@ MultiMeshInstance2D 使用默认 :ref:`CanvasItemMaterial` 时，将使用的 :ref:`Texture2D`\ 。可以在 CanvasItem 着色器中作为 ``TEXTURE`` 访问。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multimeshinstance3d.rst b/classes/zh_CN/class_multimeshinstance3d.rst index 00d41f86f3..b9ece8f94f 100644 --- a/classes/zh_CN/class_multimeshinstance3d.rst +++ b/classes/zh_CN/class_multimeshinstance3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiMeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMeshInstance3D.xml. .. _class_MultiMeshInstance3D: @@ -72,6 +72,7 @@ MultiMeshInstance3D 将在 **MultiMeshInstance3D** 的所有实例之间，使用和共享的 :ref:`MultiMesh` 资源。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayerapi.rst b/classes/zh_CN/class_multiplayerapi.rst index 6a0cfd0e74..52c34b70d7 100644 --- a/classes/zh_CN/class_multiplayerapi.rst +++ b/classes/zh_CN/class_multiplayerapi.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiplayerAPI.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerAPI.xml. .. _class_MultiplayerAPI: @@ -364,6 +364,7 @@ enum **RPCMode**: :ref:`🔗` 设置默认的 MultiplayerAPI 实现类。模块和扩展可以使用这个方法来配置引擎启动时 :ref:`SceneTree` 将使用哪个实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayerapiextension.rst b/classes/zh_CN/class_multiplayerapiextension.rst index d65ea9bd41..a9d9f2c022 100644 --- a/classes/zh_CN/class_multiplayerapiextension.rst +++ b/classes/zh_CN/class_multiplayerapiextension.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiplayerAPIExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerAPIExtension.xml. .. _class_MultiplayerAPIExtension: @@ -33,29 +33,31 @@ MultiplayerAPIExtension extends MultiplayerAPIExtension class_name LogMultiplayer - + # 我们想扩展默认的 SceneMultiplayer。 var base_multiplayer = SceneMultiplayer.new() - + func _init(): # 仅传递基本信号（复制到 var 以避免循环引用） var cts = connected_to_server var cf = connection_failed + var sd = server_disconnected var pc = peer_connected var pd = peer_disconnected base_multiplayer.connected_to_server.connect(func(): cts.emit()) base_multiplayer.connection_failed.connect(func(): cf.emit()) + base_multiplayer.server_disconnected.connect(func(): sd.emit()) base_multiplayer.peer_connected.connect(func(id): pc.emit(id)) base_multiplayer.peer_disconnected.connect(func(id): pd.emit(id)) - + func _poll(): return base_multiplayer.poll() - + # 记录正在进行的 RPC 并将其转发到默认的多人游戏。 func _rpc(peer: int, object: Object, method: StringName, args: Array) -> Error: print("获取用于 %d 的 RPC：%s::%s(%s)" % [peer, object, method, args]) return base_multiplayer.rpc(peer, object, method, args) - + # 记录配置添加。例如，根路径（nullptr、NodePath），复制（Node、Spawner|Synchronizer），自定义。 func _object_configuration_add(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: @@ -63,7 +65,7 @@ MultiplayerAPIExtension elif config is MultiplayerSpawner: print("将节点 %s 添加到出生列表。出生器：%s" % [object, config]) return base_multiplayer.object_configuration_add(object, config) - + # 记录配置移除。例如，根路径（nullptr、NodePath），复制（Node、Spawner|Synchronizer），自定义。 func _object_configuration_remove(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: @@ -71,17 +73,20 @@ MultiplayerAPIExtension elif config is MultiplayerSpawner: print("将节点 %s 从出生列表移除。出生器：%s" % [object, config]) return base_multiplayer.object_configuration_remove(object, config) - + # 这些可以是可选的，但在我们的例子中，我们想要扩展 SceneMultiplayer，所以转发所有内容。 func _set_multiplayer_peer(p_peer: MultiplayerPeer): base_multiplayer.multiplayer_peer = p_peer - + func _get_multiplayer_peer() -> MultiplayerPeer: return base_multiplayer.multiplayer_peer - + func _get_unique_id() -> int: return base_multiplayer.get_unique_id() - + + func _get_remote_sender_id() -> int: + return base_multiplayer.get_remote_sender_id() + func _get_peer_ids() -> PackedInt32Array: return base_multiplayer.get_peers() @@ -245,6 +250,7 @@ MultiplayerAPIExtension 在设置 :ref:`MultiplayerAPI.multiplayer_peer` 时调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayerpeer.rst b/classes/zh_CN/class_multiplayerpeer.rst index ff9db41844..a4567c3918 100644 --- a/classes/zh_CN/class_multiplayerpeer.rst +++ b/classes/zh_CN/class_multiplayerpeer.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerPeer.xml. .. _class_MultiplayerPeer: @@ -268,7 +268,7 @@ enum **TransferMode**: :ref:`🔗` - |void| **set_transfer_mode**\ (\ value\: :ref:`TransferMode`\ ) - :ref:`TransferMode` **get_transfer_mode**\ (\ ) -向目标对等体发送数据包的方式。请参阅 :ref:`TransferMode` 和 :ref:`set_target_peer()` 方法。 +向目标对等体发送数据包的方式。见 :ref:`set_target_peer()` 方法。 .. rst-class:: classref-section-separator @@ -321,7 +321,7 @@ enum **TransferMode**: :ref:`🔗` :ref:`ConnectionStatus` **get_connection_status**\ (\ ) |const| :ref:`🔗` -返回连接的当前状态。见 :ref:`ConnectionStatus`\ 。 +返回连接的当前状态。 .. rst-class:: classref-item-separator @@ -410,6 +410,7 @@ enum **TransferMode**: :ref:`🔗` \ ``id`` 可以是以下之一：\ :ref:`TARGET_PEER_BROADCAST`\ ，以发送到所有连接的对等体；\ :ref:`TARGET_PEER_SERVER`\ ，以发送到充当服务器的对等体；一个有效的对等体 ID ，以发送到那个特定的对等体；一个负的对等体 ID，以发送到除那个对等体以外的所有对等体。默认情况下，目标对等体是 :ref:`TARGET_PEER_BROADCAST`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayerpeerextension.rst b/classes/zh_CN/class_multiplayerpeerextension.rst index 52d426c126..09f1aab823 100644 --- a/classes/zh_CN/class_multiplayerpeerextension.rst +++ b/classes/zh_CN/class_multiplayerpeerextension.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/MultiplayerPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerPeerExtension.xml. .. _class_MultiplayerPeerExtension: @@ -32,53 +32,53 @@ MultiplayerPeerExtension .. table:: :widths: auto - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_close`\ (\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_disconnect_peer`\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConnectionStatus` | :ref:`_get_connection_status`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_packet_channel`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TransferMode` | :ref:`_get_packet_mode`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_packet_peer`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`_get_packet_script`\ (\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_transfer_channel`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TransferMode` | :ref:`_get_transfer_mode`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_unique_id`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_refusing_new_connections`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_server`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_server_relay_supported`\ (\ ) |virtual| |const| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_poll`\ (\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet`\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet_script`\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_refuse_new_connections`\ (\ p_enable\: :ref:`bool`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_target_peer`\ (\ p_peer\: :ref:`int`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_transfer_channel`\ (\ p_channel\: :ref:`int`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_transfer_mode`\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_close`\ (\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_disconnect_peer`\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConnectionStatus` | :ref:`_get_connection_status`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_packet_channel`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`_get_packet_mode`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_packet_peer`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_get_packet_script`\ (\ ) |virtual| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_transfer_channel`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`_get_transfer_mode`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_unique_id`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_refusing_new_connections`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_server`\ (\ ) |virtual| |required| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_server_relay_supported`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_poll`\ (\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet`\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet_script`\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_refuse_new_connections`\ (\ p_enable\: :ref:`bool`\ ) |virtual| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_target_peer`\ (\ p_peer\: :ref:`int`\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transfer_channel`\ (\ p_channel\: :ref:`int`\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transfer_mode`\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| |required| | + +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -93,7 +93,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_close**\ (\ ) |virtual| :ref:`🔗` +|void| **_close**\ (\ ) |virtual| |required| :ref:`🔗` 该多人游戏对等体应当立即关闭时调用（见 :ref:`MultiplayerPeer.close()`\ ）。 @@ -105,7 +105,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_disconnect_peer**\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_disconnect_peer**\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 应当强制断开与对等体 ``p_peer`` 的连接时调用（见 :ref:`MultiplayerPeer.disconnect_peer()`\ ）。 @@ -117,7 +117,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`MultiplayerAPI` 对可用的数据包数量发出内部请求时调用。 @@ -129,7 +129,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`ConnectionStatus` **_get_connection_status**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`ConnectionStatus` **_get_connection_status**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`MultiplayerAPI` 请求连接状态时调用（见 :ref:`MultiplayerPeer.get_connection_status()`\ ）。 @@ -141,7 +141,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`MultiplayerAPI` 请求最大允许的数据包大小（单位为字节）时调用。 @@ -165,7 +165,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_packet_channel**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_packet_channel**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回接收下一个可用数据包所使用的通道。请参阅 :ref:`MultiplayerPeer.get_packet_channel()`\ 。 @@ -177,7 +177,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`TransferMode` **_get_packet_mode**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`TransferMode` **_get_packet_mode**\ (\ ) |virtual| |required| |const| :ref:`🔗` 调用以获取远程对等体用于发送下一个可用数据包的传输模式。请参阅 :ref:`MultiplayerPeer.get_packet_mode()`\ 。 @@ -189,7 +189,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_packet_peer**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_packet_peer**\ (\ ) |virtual| |required| |const| :ref:`🔗` 请求最近数据包发送方 :ref:`MultiplayerPeer` 的 ID 时调用（见 :ref:`MultiplayerPeer.get_packet_peer()`\ ）。 @@ -213,7 +213,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_transfer_channel**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_transfer_channel**\ (\ ) |virtual| |required| |const| :ref:`🔗` 读取 :ref:`MultiplayerPeer` 所使用的传输通道时调用（见 :ref:`MultiplayerPeer.transfer_channel`\ ）。 @@ -225,7 +225,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`TransferMode` **_get_transfer_mode**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`TransferMode` **_get_transfer_mode**\ (\ ) |virtual| |required| |const| :ref:`🔗` 读取 :ref:`MultiplayerPeer` 所使用的传输模式时调用（见 :ref:`MultiplayerPeer.transfer_mode`\ ）。 @@ -237,7 +237,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_unique_id**\ (\ ) |virtual| |required| |const| :ref:`🔗` 请求 :ref:`MultiplayerPeer` 的唯一 ID 时调用（见 :ref:`MultiplayerPeer.get_unique_id()`\ ）。取值必须在 ``1`` 和 ``2147483647`` 之间。 @@ -261,7 +261,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -:ref:`bool` **_is_server**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_server**\ (\ ) |virtual| |required| |const| :ref:`🔗` 请求 :ref:`MultiplayerPeer` 的“是否为服务器”状态时调用。见 :ref:`MultiplayerAPI.is_server()`\ 。 @@ -285,7 +285,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_poll**\ (\ ) |virtual| :ref:`🔗` +|void| **_poll**\ (\ ) |virtual| |required| :ref:`🔗` 轮询 :ref:`MultiplayerPeer` 时调用。见 :ref:`MultiplayerAPI.poll()`\ 。 @@ -333,7 +333,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_set_target_peer**\ (\ p_peer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_set_target_peer**\ (\ p_peer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 设置 :ref:`MultiplayerPeer` 所使用的目标对等体时调用（见 :ref:`MultiplayerPeer.set_target_peer()`\ ）。 @@ -345,7 +345,7 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_set_transfer_channel**\ (\ p_channel\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_set_transfer_channel**\ (\ p_channel\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 设置 :ref:`MultiplayerPeer` 所使用的通道时调用（见 :ref:`MultiplayerPeer.transfer_channel`\ ）。 @@ -357,11 +357,12 @@ MultiplayerPeerExtension .. rst-class:: classref-method -|void| **_set_transfer_mode**\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| :ref:`🔗` +|void| **_set_transfer_mode**\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| |required| :ref:`🔗` 设置 :ref:`MultiplayerPeer` 所使用的传输模式时调用（见 :ref:`MultiplayerPeer.transfer_mode`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayerspawner.rst b/classes/zh_CN/class_multiplayerspawner.rst index db03077a82..47452f96fb 100644 --- a/classes/zh_CN/class_multiplayerspawner.rst +++ b/classes/zh_CN/class_multiplayerspawner.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/multiplayer/doc_classes/MultiplayerSpawner.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/MultiplayerSpawner.xml. .. _class_MultiplayerSpawner: @@ -221,6 +221,7 @@ MultiplayerSpawner \ **注意：**\ 可出生的场景是自动出生的。\ :ref:`spawn()` 仅在自定义出生时需要。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_multiplayersynchronizer.rst b/classes/zh_CN/class_multiplayersynchronizer.rst index ce99bf946b..f55a71fcbe 100644 --- a/classes/zh_CN/class_multiplayersynchronizer.rst +++ b/classes/zh_CN/class_multiplayersynchronizer.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml. .. _class_MultiplayerSynchronizer: @@ -261,7 +261,7 @@ enum **VisibilityUpdateMode**: :ref:`🔗`\ ) - :ref:`VisibilityUpdateMode` **get_visibility_update_mode**\ (\ ) -指定何时更新可见性过滤器（有关选项见 :ref:`VisibilityUpdateMode`\ ）。 +指定何时更新可见性过滤器。 .. rst-class:: classref-section-separator @@ -331,6 +331,7 @@ enum **VisibilityUpdateMode**: :ref:`🔗` 的次数超过调用 :ref:`lock()` 的次数，导致尝试解锁未加锁的互斥器，是错误的行为，可能引起崩溃和死锁。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_nativemenu.rst b/classes/zh_CN/class_nativemenu.rst index 9b87dd0b3e..ad49d0009d 100644 --- a/classes/zh_CN/class_nativemenu.rst +++ b/classes/zh_CN/class_nativemenu.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NativeMenu.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NativeMenu.xml. .. _class_NativeMenu: @@ -28,7 +28,7 @@ NativeMenu :: var menu - + func _menu_callback(item_id): if item_id == "ITEM_CUT": cut() @@ -36,7 +36,7 @@ NativeMenu copy() elif item_id == "ITEM_PASTE": paste() - + func _enter_tree(): # 创建新菜单并添加项目： menu = NativeMenu.create_menu() @@ -44,11 +44,11 @@ NativeMenu NativeMenu.add_item(menu, "Copy", _menu_callback, Callable(), "ITEM_COPY") NativeMenu.add_separator(menu) NativeMenu.add_item(menu, "Paste", _menu_callback, Callable(), "ITEM_PASTE") - + func _on_button_pressed(): # 在鼠标位置显示弹出菜单： NativeMenu.popup(menu, DisplayServer.mouse_get_position()) - + func _exit_tree(): # 当不再需要时移除菜单： NativeMenu.free_menu(menu) @@ -1326,6 +1326,7 @@ Dock 图标右键菜单 ID（在 macOS 上，该菜单包括标准应用程序 \ **注意：**\ 该方法仅在 macOS 上实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationagent2d.rst b/classes/zh_CN/class_navigationagent2d.rst index 63275a6f1d..b6a0ff5d23 100644 --- a/classes/zh_CN/class_navigationagent2d.rst +++ b/classes/zh_CN/class_navigationagent2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationAgent2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationAgent2D.xml. .. _class_NavigationAgent2D: @@ -27,6 +27,8 @@ NavigationAgent2D \ **注意：**\ 设置 :ref:`target_position` 属性之后，必须在每个物理帧使用一次 :ref:`get_next_path_position()` 函数来更新导航代理的内部路径逻辑。这个函数返回的向量位置应该用作该代理的父节点的下一次移动位置。 +\ **注意：**\ 这个类的 :ref:`get_next_path_position()` 等方法会触发新的路径计算。在代理的 :ref:`waypoint_reached` 等信号中调用这些方法会造成无限递归。建议在物理步骤中调用这些方法，也可以推迟到当前帧的末尾再调用（见 :ref:`Object.call_deferred()` 或 :ref:`Object.CONNECT_DEFERRED`\ ）。 + .. rst-class:: classref-introduction-group 教程 @@ -77,6 +79,14 @@ NavigationAgent2D +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_return_max_length` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_return_max_radius` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_search_max_distance` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`path_search_max_polygons` | ``4096`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`radius` | ``10.0`` | @@ -125,6 +135,8 @@ NavigationAgent2D +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_next_path_position`\ (\ ) | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_path_length`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_navigation_finished`\ (\ ) | @@ -555,6 +567,76 @@ NavigationAgent2D ---- +.. _class_NavigationAgent2D_property_path_return_max_length: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_length**\ (\ ) + +返回路径允许的最大长度，单位为世界单位。路径超出该长度后会被截断。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent2D_property_path_return_max_radius: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_radius** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_radius**\ (\ ) + +返回路径从起点开始所允许的最大半径，单位为世界单位。路径超出该半径后会被截断。与 :ref:`path_return_max_length` 相比，当代理需要绕过拐角时，该属性能够允许代理走得更远。 + +\ **注意：**\ 该属性会执行球面裁剪，只会考虑实际的导航网格路径点，路径上的第一个位置是球体中心。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent2D_property_path_search_max_distance: + +.. rst-class:: classref-property + +:ref:`float` **path_search_max_distance** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_search_max_distance**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的多边形的最大距离。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent2D_property_path_search_max_polygons: + +.. rst-class:: classref-property + +:ref:`int` **path_search_max_polygons** = ``4096`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_polygons**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_path_search_max_polygons**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的最大多边形数。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent2D_property_pathfinding_algorithm: .. rst-class:: classref-property @@ -583,9 +665,9 @@ NavigationAgent2D - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) -该避障代理的半径。这是该避障代理的“身体”，不是避障机制的起始半径（由 :ref:`neighbor_distance` 控制）。 +避障代理的半径。这是该避障代理的“身体”，不是避障机制的起始半径（由 :ref:`neighbor_distance` 控制）。 -不会影响正常的寻路。要修改角色的寻路半径，请在烘焙 :ref:`NavigationMesh` 资源时使用不同的 :ref:`NavigationMesh.agent_radius` 属性，针对不同的角色大小使用不同的导航地图。 +不会影响正常的寻路。要修改角色的寻路半径，请在烘焙 :ref:`NavigationPolygon` 资源时使用不同的 :ref:`NavigationPolygon.agent_radius` 属性，针对不同的角色大小使用不同的导航地图。 .. rst-class:: classref-item-separator @@ -841,6 +923,18 @@ NavigationAgent2D ---- +.. _class_NavigationAgent2D_method_get_path_length: + +.. rst-class:: classref-method + +:ref:`float` **get_path_length**\ (\ ) |const| :ref:`🔗` + +返回当前计算得到的路径的长度。如果仍在计算路径或尚未请求计算，则返回值为 ``0.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent2D_method_get_rid: .. rst-class:: classref-method @@ -948,6 +1042,7 @@ NavigationAgent2D 将防撞仿真的内部速度替换为 ``velocity``\ 。代理传送到新的位置之后，应该在同一帧里使用这个函数。如果频繁调用这个函数，可能会让代理卡住。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationagent3d.rst b/classes/zh_CN/class_navigationagent3d.rst index cbe2c0e821..b4d7d49491 100644 --- a/classes/zh_CN/class_navigationagent3d.rst +++ b/classes/zh_CN/class_navigationagent3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationAgent3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationAgent3D.xml. .. _class_NavigationAgent3D: @@ -27,6 +27,8 @@ NavigationAgent3D \ **注意：**\ 设置 :ref:`target_position` 属性之后，必须在每个物理帧使用一次 :ref:`get_next_path_position()` 函数来更新导航代理的内部路径逻辑。这个函数返回的向量位置应该用作该代理的父节点的下一次移动位置。 +\ **注意：**\ 这个类的 :ref:`get_next_path_position()` 等方法会触发新的路径计算。在代理的 :ref:`waypoint_reached` 等信号中调用这些方法会造成无限递归。建议在物理步骤中调用这些方法，也可以推迟到当前帧的末尾再调用（见 :ref:`Object.call_deferred()` 或 :ref:`Object.CONNECT_DEFERRED`\ ）。 + .. rst-class:: classref-introduction-group 教程 @@ -81,6 +83,14 @@ NavigationAgent3D +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_return_max_length` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_return_max_radius` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_search_max_distance` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`path_search_max_polygons` | ``4096`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`radius` | ``0.5`` | @@ -131,6 +141,8 @@ NavigationAgent3D +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_next_path_position`\ (\ ) | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_path_length`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_navigation_finished`\ (\ ) | @@ -595,6 +607,76 @@ NavigationAgent3D ---- +.. _class_NavigationAgent3D_property_path_return_max_length: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_length**\ (\ ) + +返回路径允许的最大长度，单位为世界单位。路径超出该长度后会被截断。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent3D_property_path_return_max_radius: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_radius** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_radius**\ (\ ) + +返回路径从起点开始所允许的最大半径，单位为世界单位。路径超出该半径后会被截断。与 :ref:`path_return_max_length` 相比，当代理需要绕过拐角时，该属性能够允许代理走得更远。 + +\ **注意：**\ 该属性会执行球面裁剪，只会考虑实际的导航网格路径点，路径上的第一个位置是球体中心。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent3D_property_path_search_max_distance: + +.. rst-class:: classref-property + +:ref:`float` **path_search_max_distance** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_search_max_distance**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的多边形的最大距离。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent3D_property_path_search_max_polygons: + +.. rst-class:: classref-property + +:ref:`int` **path_search_max_polygons** = ``4096`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_polygons**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_path_search_max_polygons**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的最大多边形数。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent3D_property_pathfinding_algorithm: .. rst-class:: classref-property @@ -900,6 +982,18 @@ NavigationAgent3D ---- +.. _class_NavigationAgent3D_method_get_path_length: + +.. rst-class:: classref-method + +:ref:`float` **get_path_length**\ (\ ) |const| :ref:`🔗` + +返回当前计算得到的路径的长度。如果仍在计算路径或尚未请求计算，则返回值为 ``0.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent3D_method_get_rid: .. rst-class:: classref-method @@ -1007,6 +1101,7 @@ NavigationAgent3D 将防撞仿真的内部速度替换为 ``velocity``\ 。代理传送到新的位置之后，应该在同一帧里使用这个函数。如果频繁调用这个函数，可能会让代理卡住。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationlink2d.rst b/classes/zh_CN/class_navigationlink2d.rst index 961425102d..2d4cad2f9d 100644 --- a/classes/zh_CN/class_navigationlink2d.rst +++ b/classes/zh_CN/class_navigationlink2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationLink2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink2D.xml. .. _class_NavigationLink2D: @@ -328,6 +328,7 @@ NavigationLink2D 设置该链接应使用的导航地图的 :ref:`RID`\ 。默认情况下，该链接会自动加入 :ref:`World2D` 默认导航地图，因此该函数只需要覆盖默认地图即可。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationlink3d.rst b/classes/zh_CN/class_navigationlink3d.rst index ca38024c40..fc8cf4e05f 100644 --- a/classes/zh_CN/class_navigationlink3d.rst +++ b/classes/zh_CN/class_navigationlink3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationLink3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink3D.xml. .. _class_NavigationLink3D: @@ -328,6 +328,7 @@ NavigationLink3D 设置该链接应使用的导航地图的 :ref:`RID`\ 。默认情况下，该链接会自动加入 :ref:`World3D` 默认导航地图，因此该函数只需要覆盖默认地图即可。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationmesh.rst b/classes/zh_CN/class_navigationmesh.rst index 682b423f01..d32c3649ca 100644 --- a/classes/zh_CN/class_navigationmesh.rst +++ b/classes/zh_CN/class_navigationmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMesh.xml. .. _class_NavigationMesh: @@ -326,9 +326,11 @@ enum **SourceGeometryMode**: :ref:`🔗` - |void| **set_agent_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_agent_radius**\ (\ ) -侵蚀/缩小远离障碍物的高度场的可行走区域距离。 +从障碍物处侵蚀/缩小高度场可行走区域的距离。 -\ **注意：**\ 烘焙时，这个值会向上取整到最接近的 :ref:`cell_size` 的倍数。 +\ **注意：**\ 烘焙过程中会将这个值向上舍入到最接近的 :ref:`cell_size` 的倍数。 + +\ **注意：**\ 半径必须大于等于 ``0.0``\ 。如果半径为 ``0.0``\ ，则无法在烘焙过程中修复无效的轮廓重叠和其他精度错误。因此，某些障碍物可能会被错误地排除在最终导航网格之外，或者可能会删除导航网格的多边形。 .. rst-class:: classref-item-separator @@ -349,7 +351,7 @@ enum **SourceGeometryMode**: :ref:`🔗` 要烘焙与图块对齐的导航网格，防止图块边缘被 :ref:`agent_radius` 收缩，请与 :ref:`filter_baking_aabb` 配合使用并将 :ref:`edge_max_error` 设为 ``1.0`` 或小于边框大小的值。 -\ **注意：**\ 烘焙时，这个值如果不等于零，就会被向上取整到 :ref:`cell_size` 的整数倍。 +\ **注意：**\ 如果这个值不为 ``0.0``\ ，则会在烘焙时向上取整到 :ref:`cell_size` 的整数倍。 .. rst-class:: classref-item-separator @@ -574,7 +576,7 @@ enum **SourceGeometryMode**: :ref:`🔗` - |void| **set_parsed_geometry_type**\ (\ value\: :ref:`ParsedGeometryType`\ ) - :ref:`ParsedGeometryType` **get_parsed_geometry_type**\ (\ ) -决定哪种类型的节点可解析为几何图形。可能的取值见 :ref:`ParsedGeometryType`\ 。 +决定哪种类型的节点可解析为几何图形。 .. rst-class:: classref-item-separator @@ -591,7 +593,7 @@ enum **SourceGeometryMode**: :ref:`🔗` - |void| **set_source_geometry_mode**\ (\ value\: :ref:`SourceGeometryMode`\ ) - :ref:`SourceGeometryMode` **get_source_geometry_mode**\ (\ ) -烘焙时使用的几何体的来源。可能的取值见 :ref:`SourceGeometryMode`\ 。 +烘焙时使用的几何体来源。 .. rst-class:: classref-item-separator @@ -665,7 +667,7 @@ enum **SourceGeometryMode**: :ref:`🔗` - |void| **set_sample_partition_type**\ (\ value\: :ref:`SamplePartitionType`\ ) - :ref:`SamplePartitionType` **get_sample_partition_type**\ (\ ) -创建导航网格多边形单元的分割算法。可能的取值见 :ref:`SamplePartitionType`\ 。 +创建导航网格多边形单元的分割算法。 .. rst-class:: classref-item-separator @@ -812,6 +814,7 @@ enum **SourceGeometryMode**: :ref:`🔗` 设置顶点，可以使用 :ref:`add_polygon()` 方法对其进行索引，创建多边形。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationmeshgenerator.rst b/classes/zh_CN/class_navigationmeshgenerator.rst index 7346c48df0..4c4aa125dd 100644 --- a/classes/zh_CN/class_navigationmeshgenerator.rst +++ b/classes/zh_CN/class_navigationmeshgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationMeshGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshGenerator.xml. .. _class_NavigationMeshGenerator: @@ -116,6 +116,7 @@ NavigationMeshGenerator \ **注意：**\ 从 :ref:`Mesh` 资源读取数据数组虽然很方便，但会对帧率造成负面影响。这些数据需要从 GPU 获取，卡住正在处理的 :ref:`RenderingServer`\ 。出于性能考量，请优先使用碰撞形状或在代码中创建完整的数据数组等方法。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationmeshsourcegeometrydata2d.rst b/classes/zh_CN/class_navigationmeshsourcegeometrydata2d.rst index 8f8e1825fa..9f5dbb15fc 100644 --- a/classes/zh_CN/class_navigationmeshsourcegeometrydata2d.rst +++ b/classes/zh_CN/class_navigationmeshsourcegeometrydata2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationMeshSourceGeometryData2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshSourceGeometryData2D.xml. .. _class_NavigationMeshSourceGeometryData2D: @@ -277,6 +277,7 @@ NavigationMeshSourceGeometryData2D 设置所有可遍历区域轮廓数组。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationmeshsourcegeometrydata3d.rst b/classes/zh_CN/class_navigationmeshsourcegeometrydata3d.rst index 6ce0e5153c..387fe43da2 100644 --- a/classes/zh_CN/class_navigationmeshsourcegeometrydata3d.rst +++ b/classes/zh_CN/class_navigationmeshsourcegeometrydata3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationMeshSourceGeometryData3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshSourceGeometryData3D.xml. .. _class_NavigationMeshSourceGeometryData3D: @@ -287,6 +287,7 @@ NavigationMeshSourceGeometryData3D \ **警告：**\ 数据不正确会导致相关第三方库在烘焙过程中崩溃。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationobstacle2d.rst b/classes/zh_CN/class_navigationobstacle2d.rst index 5ba5b5add7..5a85da3c72 100644 --- a/classes/zh_CN/class_navigationobstacle2d.rst +++ b/classes/zh_CN/class_navigationobstacle2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationObstacle2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationObstacle2D.xml. .. _class_NavigationObstacle2D: @@ -274,6 +274,7 @@ NavigationObstacle2D 设置该 NavigationObstacle 节点应使用的导航地图的 :ref:`RID`\ ，并会更新 NavigationServer 上的 ``obstacle``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationobstacle3d.rst b/classes/zh_CN/class_navigationobstacle3d.rst index 63166a3a50..3c03e04fac 100644 --- a/classes/zh_CN/class_navigationobstacle3d.rst +++ b/classes/zh_CN/class_navigationobstacle3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationObstacle3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationObstacle3D.xml. .. _class_NavigationObstacle3D: @@ -314,6 +314,7 @@ NavigationObstacle3D 设置该 NavigationObstacle 节点应使用的导航地图的 :ref:`RID`\ ，并会更新 NavigationServer 上的 ``obstacle``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationpathqueryparameters2d.rst b/classes/zh_CN/class_navigationpathqueryparameters2d.rst index a0118d1b8c..8b65d93a7b 100644 --- a/classes/zh_CN/class_navigationpathqueryparameters2d.rst +++ b/classes/zh_CN/class_navigationpathqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationPathQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryParameters2D.xml. .. _class_NavigationPathQueryParameters2D: @@ -38,25 +38,37 @@ NavigationPathQueryParameters2D .. table:: :widths: auto - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`RID` | :ref:`map` | ``RID()`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`int` | :ref:`navigation_layers` | ``1`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`float` | :ref:`simplify_epsilon` | ``0.0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`simplify_path` | ``false`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`Vector2` | :ref:`start_position` | ``Vector2(0, 0)`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 0)`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`excluded_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`included_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`RID` | :ref:`map` | ``RID()`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`int` | :ref:`navigation_layers` | ``1`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`float` | :ref:`path_return_max_length` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`float` | :ref:`path_return_max_radius` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`float` | :ref:`path_search_max_distance` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`int` | :ref:`path_search_max_polygons` | ``4096`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`float` | :ref:`simplify_epsilon` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`simplify_path` | ``false`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`start_position` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 0)`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator @@ -174,6 +186,44 @@ flags **PathMetadataFlags**: :ref:`🔗`\[:ref:`RID`\] **excluded_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_excluded_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_excluded_regions**\ (\ ) + +将被排除在路径查询之外的区块的 :ref:`RID` 列表。请使用 :ref:`NavigationRegion2D.get_rid()` 来获取与派生自 :ref:`NavigationRegion2D` 的节点关联的 :ref:`RID`\ 。 + +\ **注意：**\ 返回的数组为副本，对其进行的修改不会更新原有属性。更新时，请先修改返回的数组，然后将其重新赋值回该属性。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters2D_property_included_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **included_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_included_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_included_regions**\ (\ ) + +将被排除在路径查询之外的区块的 :ref:`RID` 列表。请使用 :ref:`NavigationRegion2D.get_rid()` 来获取与派生自 :ref:`NavigationRegion2D` 的节点关联的 :ref:`RID`\ 。如果留空则会包含所有区块。如果区块最终同时处于包含和排除状态，则会被排除。 + +\ **注意：**\ 返回的数组为副本，对其进行的修改不会更新原有属性。更新时，请先修改返回的数组，然后将其重新赋值回该属性。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters2D_property_map: .. rst-class:: classref-property @@ -242,6 +292,76 @@ flags **PathMetadataFlags**: :ref:`🔗` **path_return_max_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_length**\ (\ ) + +返回路径允许的最大长度，单位为世界单位。路径超出该长度后会被截断。设为小于等于 ``0`` 时为禁用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters2D_property_path_return_max_radius: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_radius** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_radius**\ (\ ) + +返回路径从起点开始所允许的最大半径，单位为世界单位。路径超出该半径后会被截断。取值小于等于 ``0`` 时视为禁用。 + +\ **注意：**\ 该属性会对路径执行圆形裁剪，路径上的第一个位置是圆心所在的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters2D_property_path_search_max_distance: + +.. rst-class:: classref-property + +:ref:`float` **path_search_max_distance** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_search_max_distance**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的多边形的最大距离。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters2D_property_path_search_max_polygons: + +.. rst-class:: classref-property + +:ref:`int` **path_search_max_polygons** = ``4096`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_polygons**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_path_search_max_polygons**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的最大多边形数。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters2D_property_pathfinding_algorithm: .. rst-class:: classref-property @@ -326,6 +446,7 @@ flags **PathMetadataFlags**: :ref:`🔗` | :ref:`map` | ``RID()`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`int` | :ref:`navigation_layers` | ``1`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`float` | :ref:`simplify_epsilon` | ``0.0`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`simplify_path` | ``false`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`start_position` | ``Vector3(0, 0, 0)`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, 0, 0)`` | - +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`excluded_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`included_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`RID` | :ref:`map` | ``RID()`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`navigation_layers` | ``1`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`path_return_max_length` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`path_return_max_radius` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`path_search_max_distance` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`path_search_max_polygons` | ``4096`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`simplify_epsilon` | ``0.0`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`simplify_path` | ``false`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`start_position` | ``Vector3(0, 0, 0)`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, 0, 0)`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-section-separator @@ -174,6 +186,44 @@ flags **PathMetadataFlags**: :ref:`🔗`\[:ref:`RID`\] **excluded_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_excluded_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_excluded_regions**\ (\ ) + +将被排除在路径查询之外的区块的 :ref:`RID` 列表。请使用 :ref:`NavigationRegion3D.get_rid()` 来获取与派生自 :ref:`NavigationRegion3D` 的节点关联的 :ref:`RID`\ 。 + +\ **注意：**\ 返回的数组为副本，对其进行的修改不会更新原有属性。更新时，请先修改返回的数组，然后将其重新赋值回该属性。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters3D_property_included_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **included_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_included_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_included_regions**\ (\ ) + +将被排除在路径查询之外的区块的 :ref:`RID` 列表。请使用 :ref:`NavigationRegion3D.get_rid()` 来获取与派生自 :ref:`NavigationRegion3D` 的节点关联的 :ref:`RID`\ 。如果留空则会包含所有区块。如果区块最终同时处于包含和排除状态，则会被排除。 + +\ **注意：**\ 返回的数组为副本，对其进行的修改不会更新原有属性。更新时，请先修改返回的数组，然后将其重新赋值回该属性。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters3D_property_map: .. rst-class:: classref-property @@ -242,6 +292,76 @@ flags **PathMetadataFlags**: :ref:`🔗` **path_return_max_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_length**\ (\ ) + +返回路径允许的最大长度，单位为世界单位。路径超出该长度后会被截断。设为小于等于 ``0`` 时为禁用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters3D_property_path_return_max_radius: + +.. rst-class:: classref-property + +:ref:`float` **path_return_max_radius** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_return_max_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_return_max_radius**\ (\ ) + +返回路径从起点开始所允许的最大半径，单位为世界单位。路径超出该半径后会被截断。取值小于等于 ``0`` 时视为禁用。 + +\ **注意：**\ 该属性会对路径执行球形裁剪，路径上的第一个位置是球心所在的位置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters3D_property_path_search_max_distance: + +.. rst-class:: classref-property + +:ref:`float` **path_search_max_distance** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_search_max_distance**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的多边形的最大距离。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters3D_property_path_search_max_polygons: + +.. rst-class:: classref-property + +:ref:`int` **path_search_max_polygons** = ``4096`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_search_max_polygons**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_path_search_max_polygons**\ (\ ) + +搜索通往目的位置多边形的路径时（可能不可达或非常远），取消寻路前能够搜索的最大多边形数。取消时，寻路会重置，构建出的路径从起始多边形开始，通往目前所找到的最接近目的位置的多边形。小于等于 ``0`` 表示不限制数量，寻路时会搜索与起始多边形相连的所有多边形，直到发现目的位置多边形或已经查过所有待查的多边形。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters3D_property_pathfinding_algorithm: .. rst-class:: classref-property @@ -326,6 +446,7 @@ flags **PathMetadataFlags**: :ref:`🔗` | :ref:`path` | ``PackedVector2Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`path_length` | ``0.0`` | + +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt64Array` | :ref:`path_owner_ids` | ``PackedInt64Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`path_rids` | ``[]`` | @@ -119,6 +121,23 @@ enum **PathSegmentType**: :ref:`🔗` **path_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_length**\ (\ ) + +返回路径的长度。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryResult2D_property_path_owner_ids: .. rst-class:: classref-property @@ -188,6 +207,7 @@ enum **PathSegmentType**: :ref:`🔗` | :ref:`path` | ``PackedVector3Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`path_length` | ``0.0`` | + +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt64Array` | :ref:`path_owner_ids` | ``PackedInt64Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`path_rids` | ``[]`` | @@ -119,6 +121,23 @@ enum **PathSegmentType**: :ref:`🔗` **path_length** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_path_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_length**\ (\ ) + +返回路径的长度。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryResult3D_property_path_owner_ids: .. rst-class:: classref-property @@ -188,6 +207,7 @@ enum **PathSegmentType**: :ref:`🔗`\ ) - :ref:`float` **get_agent_radius**\ (\ ) -烘焙导航网格时侵蚀/收缩可行走表面的距离。 +在烘焙导航网格时，用于侵蚀/缩小可行走表面的距离。 + +\ **注意：**\ 半径必须大于等于 ``0.0``\ 。如果半径为\ ``0.0``\ ，则无法在烘焙过程中修复无效的轮廓重叠和其他精度错误。因此，某些障碍物可能会被错误地排除在最终导航网格之外，也有可能会删除导航网格的多边形。 .. rst-class:: classref-item-separator @@ -407,7 +409,7 @@ enum **SourceGeometryMode**: :ref:`🔗`\ ) - :ref:`ParsedGeometryType` **get_parsed_geometry_type**\ (\ ) -决定哪种类型的节点可解析为几何图形。可能的取值见 :ref:`ParsedGeometryType`\ 。 +决定哪种类型的节点可解析为几何图形。 .. rst-class:: classref-item-separator @@ -424,7 +426,7 @@ enum **SourceGeometryMode**: :ref:`🔗`\ ) - :ref:`SamplePartitionType` **get_sample_partition_type**\ (\ ) -创建导航网格多边形单元的分割算法。可能的取值见 :ref:`SamplePartitionType`\ 。 +创建导航网格多边形单元的分割算法。 .. rst-class:: classref-item-separator @@ -460,7 +462,7 @@ enum **SourceGeometryMode**: :ref:`🔗`\ ) - :ref:`SourceGeometryMode` **get_source_geometry_mode**\ (\ ) -烘焙时使用的几何体的来源。可能的取值见 :ref:`SourceGeometryMode`\ 。 +烘焙时使用的几何体来源。 .. rst-class:: classref-section-separator @@ -549,7 +551,7 @@ enum **SourceGeometryMode**: :ref:`🔗` **get_navigation_mesh**\ (\ ) :ref:`🔗` -返回由该导航多边形产生的 :ref:`NavigationMesh`\ 。该导航网格可用于使用 :ref:`NavigationServer3D.region_set_navigation_mesh()` API 直接更新区块的导航网格（因为 2D 在幕后使用 3D 服务器）。 +返回由该导航多边形产生的 :ref:`NavigationMesh`\ 。该导航网格可用于使用 :ref:`NavigationServer3D.region_set_navigation_mesh()` API 直接更新区块的导航网格。 .. rst-class:: classref-item-separator @@ -686,6 +688,7 @@ enum **SourceGeometryMode**: :ref:`🔗` 方法对其进行索引，创建多边形。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationregion2d.rst b/classes/zh_CN/class_navigationregion2d.rst index d11175c5d1..4c2b3aaec2 100644 --- a/classes/zh_CN/class_navigationregion2d.rst +++ b/classes/zh_CN/class_navigationregion2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationRegion2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationRegion2D.xml. .. _class_NavigationRegion2D: @@ -344,6 +344,7 @@ NavigationRegion2D 设置该区块应使用的导航地图的 :ref:`RID`\ 。默认情况下，该区块会自动加入 :ref:`World2D` 默认导航地图，因此该函数只需要覆盖默认地图即可。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationregion3d.rst b/classes/zh_CN/class_navigationregion3d.rst index 3151a74f64..a23b2b295a 100644 --- a/classes/zh_CN/class_navigationregion3d.rst +++ b/classes/zh_CN/class_navigationregion3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationRegion3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationRegion3D.xml. .. _class_NavigationRegion3D: @@ -344,6 +344,7 @@ NavigationRegion3D 设置该区块应使用的导航地图的 :ref:`RID`\ 。默认情况下，该区块会自动加入 :ref:`World3D` 默认导航地图，因此该函数只需要覆盖默认地图即可。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationserver2d.rst b/classes/zh_CN/class_navigationserver2d.rst index 1a3c35fa44..0a133dcb06 100644 --- a/classes/zh_CN/class_navigationserver2d.rst +++ b/classes/zh_CN/class_navigationserver2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationServer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationServer2D.xml. .. _class_NavigationServer2D: @@ -131,6 +131,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`get_maps`\ (\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_baking_navigation_polygon`\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_create`\ (\ ) | @@ -141,6 +143,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_iteration_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | @@ -191,6 +195,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_links`\ (\ map\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_merge_rasterizer_cell_scale`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_obstacles`\ (\ map\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`map_get_path`\ (\ map\: :ref:`RID`, origin\: :ref:`Vector2`, destination\: :ref:`Vector2`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) | @@ -213,6 +219,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`map_set_link_connection_radius`\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_merge_rasterizer_cell_scale`\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`map_set_use_async_iterations`\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`map_set_use_edge_connections`\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) | @@ -271,6 +279,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`region_get_enter_cost`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_iteration_id`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`region_get_map`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`region_get_navigation_layers`\ (\ region\: :ref:`RID`\ ) |const| | @@ -283,6 +293,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`region_get_travel_cost`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_use_async_iterations`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`region_get_use_edge_connections`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`region_owns_point`\ (\ region\: :ref:`RID`, point\: :ref:`Vector2`\ ) |const| | @@ -303,8 +315,12 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`region_set_travel_cost`\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_use_async_iterations`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`region_set_use_edge_connections`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_debug_enabled`\ (\ enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`simplify_path`\ (\ path\: :ref:`PackedVector2Array`, epsilon\: :ref:`float`\ ) | @@ -323,6 +339,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 信号 ---- +.. _class_NavigationServer2D_signal_avoidance_debug_changed: + +.. rst-class:: classref-signal + +**avoidance_debug_changed**\ (\ ) :ref:`🔗` + +当避障调试设置更改时发出。仅在调试版本中可用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_signal_map_changed: .. rst-class:: classref-signal @@ -349,6 +377,101 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 .. rst-class:: classref-descriptions-group +枚举 +---- + +.. _enum_NavigationServer2D_ProcessInfo: + +.. rst-class:: classref-enumeration + +enum **ProcessInfo**: :ref:`🔗` + +.. _class_NavigationServer2D_constant_INFO_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_ACTIVE_MAPS** = ``0`` + +常量，用于获取活动导航地图的数量。 + +.. _class_NavigationServer2D_constant_INFO_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_REGION_COUNT** = ``1`` + +常量，用于获取活动导航地区的数量。 + +.. _class_NavigationServer2D_constant_INFO_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_AGENT_COUNT** = ``2`` + +常量，用于获取正在进行避障的活动导航代理的数量。 + +.. _class_NavigationServer2D_constant_INFO_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_LINK_COUNT** = ``3`` + +常量，用于获取活动导航链接的数量。 + +.. _class_NavigationServer2D_constant_INFO_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_POLYGON_COUNT** = ``4`` + +常量，用于获取导航网格多边形的数量。 + +.. _class_NavigationServer2D_constant_INFO_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_COUNT** = ``5`` + +常量，用于获取导航网格多边形的边的数量。 + +.. _class_NavigationServer2D_constant_INFO_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_MERGE_COUNT** = ``6`` + +常量，用于获取由于边键重叠而被合并的导航网格多边形的边的数量。 + +.. _class_NavigationServer2D_constant_INFO_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_CONNECTION_COUNT** = ``7`` + +常量，用以获取被认为由于边接近而连接的导航网格多边形的边的数量。 + +.. _class_NavigationServer2D_constant_INFO_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_FREE_COUNT** = ``8`` + +常量，用于获取无法合并但仍可通过边接近或链接连接的导航网格多边形的边的数量。 + +.. _class_NavigationServer2D_constant_INFO_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_OBSTACLE_COUNT** = ``9`` + +常量，用于获取活动导航障碍物的数量。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 方法说明 -------- @@ -674,7 +797,7 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 |void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` -如果 ``paused`` 为 ``true``\ ，则不会对指定的 ``agent`` 进行处理，例如不会计算避障速度以及收到避障回调。 +如果 ``paused`` 为 ``true``\ ，则不会处理 ``agent`` 所指定的代理，例如不会计算避障速度，也不会收到避障回调。 .. rst-class:: classref-item-separator @@ -812,6 +935,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_get_process_info: + +.. rst-class:: classref-method + +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| :ref:`🔗` + +返回有关 NavigationServer 当前状态的信息。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_is_baking_navigation_polygon: .. rst-class:: classref-method @@ -872,6 +1007,20 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_link_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **link_get_iteration_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回导航链接的当前迭代 ID。导航链接发生更改并同步时都会增加迭代 ID。迭代 ID 为 ``0`` 表示导航链接从未进行过同步。 + +\ **注意：**\ 迭代 ID 超过取值范围后会绕回 ``1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_link_get_map: .. rst-class:: classref-method @@ -1070,6 +1219,8 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 |void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` +**已弃用：** This method is no longer supported, as it is incompatible with asynchronous updates. It can only be used in a single-threaded context, at your own risk. + 该函数将立即强制指定的导航 ``map`` :ref:`RID` 的同步。默认情况下，导航地图仅在每个物理帧结束时同步。该函数可用于立即（重新）计算该导航地图的所有导航网格和区块连接。这使得可以在同一帧中对修改后的地图的导航路径立即执行查询（如果需要，可以执行多次）。 由于技术上的限制，当前的 NavigationServer 命令队列将被冲刷。这意味着所有已在当前物理帧中入队的更新命令都会被执行，即使是那些用于其他地图、不属于指定地图的区块和代理的更新命令。 昂贵计算的导航网格和地图的区块连接将仅针对指定地图进行。其他地图将在物理帧结束时接收正常同步。如果指定的地图在强制更新后又收到了修改，则它将在其他地图收到更新时再次更新。 @@ -1180,6 +1331,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_map_get_merge_rasterizer_cell_scale: + +.. rst-class:: classref-method + +:ref:`float` **map_get_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回地图的内部合并栅格化器的单元格缩放。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_map_get_obstacles: .. rst-class:: classref-method @@ -1316,6 +1479,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_map_set_merge_rasterizer_cell_scale: + +.. rst-class:: classref-method + +|void| **map_set_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` + +设置地图的内部合并栅格化器的单元格缩放，用于控制合并的敏感度。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_map_set_use_async_iterations: .. rst-class:: classref-method @@ -1490,7 +1665,7 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 |void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` -如果 ``paused`` 为 ``true``\ ，则不会处理指定的障碍物 ``obstacle``\ ，例如不会影响避障速度。 +如果 ``paused`` 为 ``true``\ ，则不会处理 ``obstacle`` 所指定的障碍物，例如不会影响避障速度。 .. rst-class:: classref-item-separator @@ -1668,6 +1843,20 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_region_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **region_get_iteration_id**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回导航区块的当前迭代 ID。导航区块发生更改并同步时都会增加迭代 ID。迭代 ID 为 ``0`` 表示导航区块从未进行过同步。 + +\ **注意：**\ 迭代 ID 超过取值范围后会绕回 ``1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_region_get_map: .. rst-class:: classref-method @@ -1744,6 +1933,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_region_get_use_async_iterations: + +.. rst-class:: classref-method + +:ref:`bool` **region_get_use_async_iterations**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` + +如果区块 ``region`` 的同步使用后台线程异步处理，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_region_get_use_edge_connections: .. rst-class:: classref-method @@ -1868,6 +2069,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_region_set_use_async_iterations: + +.. rst-class:: classref-method + +|void| **region_set_use_async_iterations**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则区块 ``region`` 的同步使用后台线程异步处理。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_region_set_use_edge_connections: .. rst-class:: classref-method @@ -1880,6 +2093,18 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 ---- +.. _class_NavigationServer2D_method_set_active: + +.. rst-class:: classref-method + +|void| **set_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` + +控制这个服务器是否激活。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_set_debug_enabled: .. rst-class:: classref-method @@ -1933,6 +2158,7 @@ NavigationServer2D 是负责处理导航地图、区块、代理的服务器。 - ``node`` - 解析的 :ref:`Node`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_navigationserver3d.rst b/classes/zh_CN/class_navigationserver3d.rst index bd858bcfeb..44b7d085db 100644 --- a/classes/zh_CN/class_navigationserver3d.rst +++ b/classes/zh_CN/class_navigationserver3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NavigationServer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationServer3D.xml. .. _class_NavigationServer3D: @@ -151,6 +151,8 @@ NavigationServer3D 是处理导航地图、区块、代理的服务器。它不 +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_iteration_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | @@ -311,6 +313,8 @@ NavigationServer3D 是处理导航地图、区块、代理的服务器。它不 +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`region_get_enter_cost`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_iteration_id`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`region_get_map`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`region_get_navigation_layers`\ (\ region\: :ref:`RID`\ ) |const| | @@ -323,6 +327,8 @@ NavigationServer3D 是处理导航地图、区块、代理的服务器。它不 +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`region_get_travel_cost`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_use_async_iterations`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`region_get_use_edge_connections`\ (\ region\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`region_owns_point`\ (\ region\: :ref:`RID`, point\: :ref:`Vector3`\ ) |const| | @@ -343,6 +349,8 @@ NavigationServer3D 是处理导航地图、区块、代理的服务器。它不 +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`region_set_travel_cost`\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_use_async_iterations`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`region_set_use_edge_connections`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | @@ -859,7 +867,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` -如果 ``paused`` 为 ``true``\ ，则不会对指定的 ``agent`` 进行处理，例如不会计算避障速度以及收到避障回调。 +如果 ``paused`` 为 ``true``\ ，则不会处理 ``agent`` 所指定的代理，例如不会计算避障速度，也不会收到避障回调。 .. rst-class:: classref-item-separator @@ -1019,7 +1027,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| :ref:`🔗` -返回有关 NavigationServer 当前状态的信息。有关可用状态的列表，请参阅 :ref:`ProcessInfo`\ 。 +返回有关 NavigationServer 当前状态的信息。 .. rst-class:: classref-item-separator @@ -1085,6 +1093,20 @@ enum **ProcessInfo**: :ref:`🔗` ---- +.. _class_NavigationServer3D_method_link_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **link_get_iteration_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回导航链接的当前迭代 ID。导航链接发生更改并同步时都会增加迭代 ID。迭代 ID 为 ``0`` 表示导航链接从未进行过同步。 + +\ **注意：**\ 迭代 ID 超过取值范围后会绕回 ``1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_link_get_map: .. rst-class:: classref-method @@ -1283,6 +1305,8 @@ enum **ProcessInfo**: :ref:`🔗` |void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` +**已弃用：** This method is no longer supported, as it is incompatible with asynchronous updates. It can only be used in a single-threaded context, at your own risk. + 该函数将立即强制指定的导航 ``map`` :ref:`RID` 的同步。默认情况下，导航地图仅在每个物理帧结束时同步。该函数可用于立即（重新）计算该导航地图的所有导航网格和区块连接。这使得可以在同一帧中对修改后的地图的导航路径立即执行查询（如果需要，可以执行多次）。 由于技术上的限制，当前的 NavigationServer 命令队列将被冲刷。这意味着所有已在当前物理帧中入队的更新命令都会被执行，即使是那些用于其他地图、不属于指定地图的区块和代理的更新命令。 昂贵计算的导航网格和地图的区块连接将仅针对指定地图进行。其他地图将在物理帧结束时接收正常同步。如果指定的地图在强制更新后又收到了修改，则它将在其他地图收到更新时再次更新。 @@ -1837,7 +1861,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` -如果 ``paused`` 为 ``true``\ ，则不会处理指定的障碍物 ``obstacle``\ ，例如不会影响避障速度。 +如果 ``paused`` 为 ``true``\ ，则不会处理 ``obstacle`` 所指定的障碍物，例如不会影响避障速度。 .. rst-class:: classref-item-separator @@ -2067,6 +2091,20 @@ enum **ProcessInfo**: :ref:`🔗` ---- +.. _class_NavigationServer3D_method_region_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **region_get_iteration_id**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回导航区块的当前迭代 ID。导航区块发生更改并同步时都会增加迭代 ID。迭代 ID 为 ``0`` 表示导航区块从未进行过同步。 + +\ **注意：**\ 迭代 ID 超过取值范围后会绕回 ``1``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_region_get_map: .. rst-class:: classref-method @@ -2143,6 +2181,18 @@ enum **ProcessInfo**: :ref:`🔗` ---- +.. _class_NavigationServer3D_method_region_get_use_async_iterations: + +.. rst-class:: classref-method + +:ref:`bool` **region_get_use_async_iterations**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` + +如果区块 ``region`` 的同步使用后台线程异步处理，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_region_get_use_edge_connections: .. rst-class:: classref-method @@ -2267,6 +2317,18 @@ enum **ProcessInfo**: :ref:`🔗` ---- +.. _class_NavigationServer3D_method_region_set_use_async_iterations: + +.. rst-class:: classref-method + +|void| **region_set_use_async_iterations**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +如果 ``enabled`` 为 ``true``\ ，则区块 ``region`` 的同步使用后台线程异步处理。 + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_region_set_use_edge_connections: .. rst-class:: classref-method @@ -2344,6 +2406,7 @@ enum **ProcessInfo**: :ref:`🔗` - ``node`` - 解析的 :ref:`Node`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_ninepatchrect.rst b/classes/zh_CN/class_ninepatchrect.rst index d23a340a72..54013da7e1 100644 --- a/classes/zh_CN/class_ninepatchrect.rst +++ b/classes/zh_CN/class_ninepatchrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NinePatchRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NinePatchRect.xml. .. _class_NinePatchRect: @@ -141,7 +141,7 @@ enum **AxisStretchMode**: :ref:`🔗` - |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_h_axis_stretch_mode**\ (\ ) -水平拉伸/平铺时使用的拉伸模式。可能的取值见 :ref:`AxisStretchMode`\ 。 +水平拉伸/平铺时使用的拉伸模式。 .. rst-class:: classref-item-separator @@ -158,7 +158,7 @@ enum **AxisStretchMode**: :ref:`🔗` - |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_v_axis_stretch_mode**\ (\ ) -用于垂直拉伸/平铺的拉伸模式。可能的取值见 :ref:`AxisStretchMode`\ 。 +垂直拉伸/平铺时使用的拉伸模式。 .. rst-class:: classref-item-separator @@ -309,6 +309,7 @@ enum **AxisStretchMode**: :ref:`🔗` 将给定 :ref:`Side` 的边距大小设置为 ``value`` 像素。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_node.rst b/classes/zh_CN/class_node.rst index 5495a11bb6..50bd602c4d 100644 --- a/classes/zh_CN/class_node.rst +++ b/classes/zh_CN/class_node.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Node.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node.xml. .. _class_Node: @@ -105,8 +105,12 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_exit_tree`\ (\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_accessibility_configuration_warnings`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_configuration_warnings`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_focused_accessibility_element`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_physics_process`\ (\ delta\: :ref:`float`\ ) |virtual| | @@ -135,6 +139,8 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`call_thread_safe`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_auto_translate`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_process`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`create_tween`\ (\ ) | @@ -147,6 +153,8 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`find_parent`\ (\ pattern\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_accessibility_element`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_child`\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_child_count`\ (\ include_internal\: :ref:`bool` = false\ ) |const| | @@ -167,6 +175,10 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_node_or_null`\ (\ path\: :ref:`NodePath`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_node_rpc_config`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`get_orphan_node_ids`\ (\ ) |static| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_parent`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_path`\ (\ ) |const| | @@ -177,8 +189,6 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_process_delta_time`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_rpc_config`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_scene_instance_load_placeholder`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SceneTree` | :ref:`get_tree`\ (\ ) |const| | @@ -249,6 +259,8 @@ Node +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`propagate_notification`\ (\ what\: :ref:`int`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_accessibility_update`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`queue_free`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_child`\ (\ node\: :ref:`Node`\ ) | @@ -624,7 +636,7 @@ enum **DuplicateFlags**: :ref:`🔗` :ref:`DuplicateFlags` **DUPLICATE_SIGNALS** = ``1`` -复制该节点的信号连接。 +复制节点的信号连接中使用 :ref:`Object.CONNECT_PERSIST` 标志连接的那些连接。 .. _class_Node_constant_DUPLICATE_GROUPS: @@ -1139,6 +1151,22 @@ enum **AutoTranslateMode**: :ref:`🔗` :ref:`TextServer` 被更改时收到的通知。 +.. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_UPDATE: + +.. rst-class:: classref-constant + +**NOTIFICATION_ACCESSIBILITY_UPDATE** = ``3000`` :ref:`🔗` + +无障碍信息需要更新时收到的通知。 + +.. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_INVALIDATE: + +.. rst-class:: classref-constant + +**NOTIFICATION_ACCESSIBILITY_INVALIDATE** = ``3001`` :ref:`🔗` + +无障碍元素失效时收到的通知。收到该消息后，会自动删除节点的无障碍元素，所以应当丢弃现有的对此类元素的引用。 + .. rst-class:: classref-section-separator ---- @@ -1251,9 +1279,13 @@ enum **AutoTranslateMode**: :ref:`🔗` - |void| **set_physics_interpolation_mode**\ (\ value\: :ref:`PhysicsInterpolationMode`\ ) - :ref:`PhysicsInterpolationMode` **get_physics_interpolation_mode**\ (\ ) -允许启用或禁用每个节点的物理插值，提供比全局打开和关闭物理插值更精细的控制。请参阅 :ref:`ProjectSettings.physics/common/physics_interpolation` 和 :ref:`SceneTree.physics_interpolation` 了解全局设置。 +节点所使用的物理插值模式。仅在 :ref:`ProjectSettings.physics/common/physics_interpolation` 或 :ref:`SceneTree.physics_interpolation` 为 ``true`` 时生效。 -\ **注意：**\ 将节点传送到远处时，应使用 :ref:`reset_physics_interpolation()` 暂时禁用插值。 +节点默认继承父节点的物理插值模式。该属性可以为各个节点单独启用或禁用物理插值，使其独立于父节点的物理插值模式。 + +\ **注意：**\ :ref:`VehicleWheel3D` 等部分节点默认禁用物理插值，因为它们有自己的解决方案。 + +\ **注意：**\ 远距离传送节点时，建议在移动节点\ *之后*\ 通过 :ref:`reset_physics_interpolation()` 临时禁用插值，避免出现在新旧位置之间的视觉过渡。 .. rst-class:: classref-item-separator @@ -1270,7 +1302,7 @@ enum **AutoTranslateMode**: :ref:`🔗` - |void| **set_process_mode**\ (\ value\: :ref:`ProcessMode`\ ) - :ref:`ProcessMode` **get_process_mode**\ (\ ) -该节点的处理行为（请参阅 :ref:`ProcessMode`\ ）。要检查该节点是否能够在当前模式下进行处理，请使用 :ref:`can_process()`\ 。 +该节点的处理行为。要检查该节点是否能够在当前模式下进行处理，请使用 :ref:`can_process()`\ 。 .. rst-class:: classref-item-separator @@ -1436,6 +1468,20 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_private_method__get_accessibility_configuration_warnings: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_accessibility_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗` + +如果覆盖的脚本是 ``tool`` 脚本，并且在编辑器设置中启用了无障碍警告，那么该方法返回的数组中的元素就会作为警告显示在“场景”面板中。 + +返回空数组不会产生警告。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_private_method__get_configuration_warnings: .. rst-class:: classref-method @@ -1454,7 +1500,7 @@ enum **AutoTranslateMode**: :ref:`🔗` set(value): energy = value update_configuration_warnings() - + func _get_configuration_warnings(): if energy < 0: return ["Energy 必须大于等于 0。"] @@ -1465,6 +1511,18 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_private_method__get_focused_accessibility_element: + +.. rst-class:: classref-method + +:ref:`RID` **_get_focused_accessibility_element**\ (\ ) |virtual| |const| :ref:`🔗` + +在无障碍信息更新期间调用，确定当前聚焦的子元素，应当返回子元素的 RID 或 :ref:`get_accessibility_element()` 的返回值。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_private_method__input: .. rst-class:: classref-method @@ -1491,17 +1549,17 @@ enum **AutoTranslateMode**: :ref:`🔗` |void| **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` -在主循环的物理处理步骤中调用。物理处理的帧率与物理同步，即 ``delta`` 参数\ *通常*\ 不变（例外见下文）。\ ``delta`` 的单位为秒。 +Called once on each physics tick, and allows Nodes to synchronize their logic with physics ticks. ``delta`` is the logical time between physics ticks in seconds and is equal to :ref:`Engine.time_scale` / :ref:`Engine.physics_ticks_per_second`. -启用物理处理后才会调用该方法，覆盖该方法后会自动启用，可以使用 :ref:`set_physics_process()` 开关。 +It is only called if physics processing is enabled for this Node, which is done automatically if this method is overridden, and can be toggled with :ref:`set_physics_process()`. -处理按照 :ref:`process_physics_priority` 的顺序进行，优先级取值越低越先调用。优先级相同的节点按照树顺序处理，即编辑器中从上到下的顺序（也叫前序遍历）。 +Processing happens in order of :ref:`process_physics_priority`, lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal). -对应 :ref:`Object._notification()` 中的 :ref:`NOTIFICATION_PHYSICS_PROCESS` 通知。 +Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS` notification in :ref:`Object._notification()`. -\ **注意：**\ 节点位于场景树中才会调用该方法（即不能是孤立节点）。 +\ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). -\ **注意：**\ 运行帧率小于 :ref:`Engine.physics_ticks_per_second` / :ref:`Engine.max_physics_steps_per_frame` FPS 时 ``delta`` 会比正常情况大。这样做是为了避免产生“死亡螺旋”。在这种情况下，由于每帧物理步骤数量的不断增加，性能会急剧下降。\ :ref:`_process()` 和 :ref:`_physics_process()` 都会受此影响。因此，请避免根据 ``delta`` 来测量真实世界的秒数。请使用 :ref:`Time` 单例的方法来实现此目的，例如 :ref:`Time.get_ticks_usec()`\ 。 +\ **Note:** Accumulated ``delta`` may diverge from real world seconds. .. rst-class:: classref-item-separator @@ -1513,17 +1571,21 @@ enum **AutoTranslateMode**: :ref:`🔗` |void| **_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` -在主循环的处理步骤中调用。每一帧都会尽快进行处理，因此表示自上一帧以来时间增量的 ``delta`` 会发生变化。\ ``delta`` 的单位为秒。 +Called on each idle frame, prior to rendering, and after physics ticks have been processed. ``delta`` is the time between frames in seconds. -启用处理后才会调用该方法，覆盖该方法后会自动启用，可以使用 :ref:`set_process()` 开关。 +It is only called if processing is enabled for this Node, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process()`. -处理按照 :ref:`process_priority` 的顺序进行，优先级取值越低越先调用。优先级相同的节点按照树顺序处理，即编辑器中从上到下的顺序（也叫前序遍历）。 +Processing happens in order of :ref:`process_priority`, lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal). -对应 :ref:`Object._notification()` 中的 :ref:`NOTIFICATION_PROCESS` 通知。 +Corresponds to the :ref:`NOTIFICATION_PROCESS` notification in :ref:`Object._notification()`. -\ **注意：**\ 节点位于场景树中才会调用该方法（即不能是孤立节点）。 +\ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). -\ **注意：**\ 运行帧率小于 :ref:`Engine.physics_ticks_per_second` / :ref:`Engine.max_physics_steps_per_frame` FPS 时 ``delta`` 会比正常情况大。这样做是为了避免产生“死亡螺旋”。在这种情况下，由于每帧物理步骤数量的不断增加，性能会急剧下降。\ :ref:`_process()` 和 :ref:`_physics_process()` 都会受此影响。因此，请避免根据 ``delta`` 来测量真实世界的秒数。请使用 :ref:`Time` 单例的方法来实现此目的，例如 :ref:`Time.get_ticks_usec()`\ 。 +\ **Note:** When the engine is struggling and the frame rate is lowered, ``delta`` will increase. When ``delta`` is increased, it's capped at a maximum of :ref:`Engine.time_scale` \* :ref:`Engine.max_physics_steps_per_frame` / :ref:`Engine.physics_ticks_per_second`. As a result, accumulated ``delta`` may not represent real world time. + +\ **Note:** When ``--fixed-fps`` is enabled or the engine is running in Movie Maker mode (see :ref:`MovieWriter`), process ``delta`` will always be the same for every frame, regardless of how much time the frame took to render. + +\ **Note:** Frame delta may be post-processed by :ref:`OS.delta_smoothing` if this is enabled for the project. .. rst-class:: classref-item-separator @@ -1619,7 +1681,7 @@ enum **AutoTranslateMode**: :ref:`🔗` 如果 ``force_readable_name`` 为 ``true``\ ，则将提高所添加的 ``node`` 的可读性。如果尚未命名，\ ``node`` 将重命名为它的类型，如果存在 :ref:`name` 相同的同级节点，则会添加合适的数字后缀。这个操作很慢。因此，建议将其保留为 ``false``\ ，在这两种情况下会分配包含 ``@`` 的虚设名称。 -如果 ``internal`` 不同于 :ref:`INTERNAL_MODE_DISABLED`\ ，则该子节点将被添加为内部节点。\ :ref:`get_children()` 等方法会忽略这些节点，除非它们的参数 ``include_internal`` 为 ``true``\ 。这种功能的设计初衷是对用户隐藏内部节点，这样用户就不会意外删除或修改这些节点。部分 GUI 节点会使用这个功能，例如 :ref:`ColorPicker`\ 。可用的模式见 :ref:`InternalMode`\ 。 +如果 ``internal`` 不同于 :ref:`INTERNAL_MODE_DISABLED`\ ，则该子节点将被添加为内部节点。\ :ref:`get_children()` 等方法会忽略这些节点，除非它们的参数 ``include_internal`` 为 ``true``\ 。这种功能的设计初衷是对用户隐藏内部节点，这样用户就不会意外删除或修改这些节点。部分 GUI 节点会使用这个功能，例如 :ref:`ColorPicker`\ 。 \ **注意：**\ 如果 ``node`` 已经有父节点，则该方法会失败。请先使用 :ref:`remove_child()` 将 ``node`` 从其当前父节点中移除。例如： @@ -1752,6 +1814,18 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_method_can_auto_translate: + +.. rst-class:: classref-method + +:ref:`bool` **can_auto_translate**\ (\ ) |const| :ref:`🔗` + +如果该节点能够根据当前区域设置自动翻译消息，则返回 ``true``\ 。见 :ref:`auto_translate_mode`\ 、\ :ref:`atr()`\ 、\ :ref:`atr_n()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_can_process: .. rst-class:: classref-method @@ -1813,7 +1887,7 @@ enum **AutoTranslateMode**: :ref:`🔗` :ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| :ref:`🔗` -复制该节点，返回一个新节点，其中包含从原始节点复制的所有属性、信号、组、子节点。可以通过 ``flags`` 调整该行为（见 :ref:`DuplicateFlags`\ ）。 +复制该节点，返回一个新节点，其中包含从原始节点复制的所有属性、信号、组、子节点。可以通过 ``flags`` 调整该行为（见 :ref:`DuplicateFlags`\ ）。不会复制内部节点。 \ **注意：**\ 对于附带有 :ref:`Script` 的节点，如果 :ref:`Object._init()` 已使用所需参数定义，则复制的节点将不会有 :ref:`Script`\ 。 @@ -1877,21 +1951,35 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_method_get_accessibility_element: + +.. rst-class:: classref-method + +:ref:`RID` **get_accessibility_element**\ (\ ) |const| :ref:`🔗` + +返回主要无障碍元素 RID。 + +\ **注意：**\ 该方法只应在无障碍信息更新时调用（\ :ref:`NOTIFICATION_ACCESSIBILITY_UPDATE`\ ）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_get_child: .. rst-class:: classref-method :ref:`Node` **get_child**\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| :ref:`🔗` -通过索引获取子节点。每个子节点都有一个相对于其同级节点的索引（请参阅 :ref:`get_index()`\ ）。第一个子节点位于索引 0 处。负值也可用于从列表末尾开始。该方法可以与 :ref:`get_child_count()` 结合使用来迭代该节点的子节点。如果给定索引处不存在子节点，则该方法返回 ``null`` 并生成一个错误。 +通过索引获取子节点。每个子节点都有一个相对于其同级节点的索引（见 :ref:`get_index()`\ ）。第一个子节点位于索引 0 处。负值也可用于从列表末尾开始。该方法可以与 :ref:`get_child_count()` 结合使用来迭代该节点的子节点。如果给定索引处不存在子节点，则该方法返回 ``null`` 并生成一个错误。 -如果 ``include_internal`` 为 ``false``\ ，则忽略内部子节点（请参阅 :ref:`add_child()` 的 ``internal`` 参数）。 +如果 ``include_internal`` 为 ``false``\ ，则忽略内部子节点（见 :ref:`add_child()` 的 ``internal`` 参数）。 :: # 假设以下是该节点的子节点（按顺序）： # 第一、中间、最后。 - + var a = get_child(0).name # a 是 “第一” var b = get_child(1).name # b 是 “中间” var b = get_child(2).name # b 是 “最后” @@ -2066,13 +2154,13 @@ enum **AutoTranslateMode**: :ref:`🔗` 获取节点及其由 :ref:`NodePath` 子名指定的嵌套最深的资源。返回一个大小为 ``3`` 的 :ref:`Array`\ ，其中： -- 元素 ``0`` 是 **Node**\ ，如果找不到，则为 ``null``\ ； +- 元素 ``0`` 是 **Node**\ ，如果找不到则为 ``null``\ ； -- 元素 ``1`` 是子名中最后嵌套的 :ref:`Resource`\ ，如果找不到，则为 ``null``\ ； +- 元素 ``1`` 是子名中最后嵌套的 :ref:`Resource`\ ，如果找不到则为 ``null``\ ； -- 元素 ``2`` 是剩余的 :ref:`NodePath`\ ，引用一个已有的非 :ref:`Resource` 属性（请参阅 :ref:`Object.get_indexed()`\ ）。 +- 元素 ``2`` 是剩余的 :ref:`NodePath`\ ，引用一个已有的非 :ref:`Resource` 属性（见 :ref:`Object.get_indexed()`\ ）。 -\ **示例：**\ 假设子节点的 :ref:`Sprite2D.texture` 已被分配了一个\ :ref:`AtlasTexture`\ ： +\ **示例：**\ 假设子节点的 :ref:`Sprite2D.texture` 已被分配了一个 :ref:`AtlasTexture`\ ： .. tabs:: @@ -2080,36 +2168,36 @@ enum **AutoTranslateMode**: :ref:`🔗` .. code-tab:: gdscript var a = get_node_and_resource("Area2D/Sprite2D") - print(a[0].name) # 打印 Sprite2D - print(a[1]) # 打印 - print(a[2]) # 打印 ^"" - + print(a[0].name) # 输出 Sprite2D + print(a[1]) # 输出 + print(a[2]) # 输出 ^"" + var b = get_node_and_resource("Area2D/Sprite2D:texture:atlas") - print(b[0].name) # 打印 Sprite2D - print(b[1].get_class()) # 打印 AtlasTexture - print(b[2]) # 打印 ^"" - + print(b[0].name) # 输出 Sprite2D + print(b[1].get_class()) # 输出 AtlasTexture + print(b[2]) # 输出 ^"" + var c = get_node_and_resource("Area2D/Sprite2D:texture:atlas:region") - print(c[0].name) # 打印 Sprite2D - print(c[1].get_class()) # 打印 AtlasTexture - print(c[2]) # 打印 ^":region" + print(c[0].name) # 输出 Sprite2D + print(c[1].get_class()) # 输出 AtlasTexture + print(c[2]) # 输出 ^":region" .. code-tab:: csharp var a = GetNodeAndResource(NodePath("Area2D/Sprite2D")); - GD.Print(a[0].Name); // 打印 Sprite2D - GD.Print(a[1]); // 打印 - GD.Print(a[2]); // 打印 ^" - + GD.Print(a[0].Name); // 输出 Sprite2D + GD.Print(a[1]); // 输出 + GD.Print(a[2]); // 输出 ^" + var b = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas")); - GD.Print(b[0].name); // 打印 Sprite2D - GD.Print(b[1].get_class()); // 打印 AtlasTexture - GD.Print(b[2]); // 打印 ^"" - + GD.Print(b[0].name); // 输出 Sprite2D + GD.Print(b[1].get_class()); // 输出 AtlasTexture + GD.Print(b[2]); // 输出 ^"" + var c = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas:region")); - GD.Print(c[0].name); // 打印 Sprite2D - GD.Print(c[1].get_class()); // 打印 AtlasTexture - GD.Print(c[2]); // 打印 ^":region" + GD.Print(c[0].name); // 输出 Sprite2D + GD.Print(c[1].get_class()); // 输出 AtlasTexture + GD.Print(c[2]); // 输出 ^":region" @@ -2129,6 +2217,34 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_method_get_node_rpc_config: + +.. rst-class:: classref-method + +:ref:`Variant` **get_node_rpc_config**\ (\ ) |const| :ref:`🔗` + +返回一个 :ref:`Dictionary`\ ，将方法名称映射到为对应的 RPC 配置，这些配置使用 :ref:`rpc_config()` 定义。 + +\ **注意：**\ 该方法只会返回通过 :ref:`rpc_config()` 分配的 RPC 配置。获取由 :ref:`Script` 定义的 RPC 见 :ref:`Script.get_rpc_config()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_method_get_orphan_node_ids: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`int`\] **get_orphan_node_ids**\ (\ ) |static| :ref:`🔗` + +返回所有孤立节点（\ :ref:`SceneTree` 之外的节点）的对象 ID。适用于调试。 + +\ **注意：**\ :ref:`get_orphan_node_ids()` 仅适用于调试构建版本。在以发布模式导出的项目中，\ :ref:`get_orphan_node_ids()` 会返回空数组。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_get_parent: .. rst-class:: classref-method @@ -2197,18 +2313,6 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- -.. _class_Node_method_get_rpc_config: - -.. rst-class:: classref-method - -:ref:`Variant` **get_rpc_config**\ (\ ) |const| :ref:`🔗` - -返回一个 :ref:`Dictionary`\ ，将方法名称映射到针对该节点使用 :ref:`rpc_config()` 为其定义的 RPC 配置。 - -.. rst-class:: classref-item-separator - ----- - .. _class_Node_method_get_scene_instance_load_placeholder: .. rst-class:: classref-method @@ -2687,6 +2791,18 @@ enum **AutoTranslateMode**: :ref:`🔗` ---- +.. _class_Node_method_queue_accessibility_update: + +.. rst-class:: classref-method + +|void| **queue_accessibility_update**\ (\ ) :ref:`🔗` + +将该节点的无障碍信息更新加入队列。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_queue_free: .. rst-class:: classref-method @@ -3056,6 +3172,7 @@ enum **AutoTranslateMode**: :ref:`🔗` 刷新场景面板中为该节点显示的警告。使用 :ref:`_get_configuration_warnings()` 自定义要显示的警告消息。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_node2d.rst b/classes/zh_CN/class_node2d.rst index b788aab35c..c34237f64f 100644 --- a/classes/zh_CN/class_node2d.rst +++ b/classes/zh_CN/class_node2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Node2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node2D.xml. .. _class_Node2D: @@ -459,6 +459,7 @@ Node2D 在局部坐标系中，将该节点按给定的偏移量 ``offset`` 进行平移。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_node3d.rst b/classes/zh_CN/class_node3d.rst index e29938f2f5..a69a9d61ea 100644 --- a/classes/zh_CN/class_node3d.rst +++ b/classes/zh_CN/class_node3d.rst @@ -1,9 +1,12 @@ :github_url: hide +.. meta:: + :keywords: spatial + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Node3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node3D.xml. .. _class_Node3D: @@ -12,22 +15,22 @@ Node3D **继承：** :ref:`Node` **<** :ref:`Object` -**派生：** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OpenXRCompositionLayer`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`SpringBoneCollision3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` +**派生：** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OpenXRCompositionLayer`, :ref:`OpenXRHand`, :ref:`OpenXRRenderModel`, :ref:`OpenXRRenderModelManager`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`SpringBoneCollision3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` -最基本的 3D 游戏对象，所有 3D 相关节点的父类。 +3D 空间中的基础对象，所有 3D 节点都会继承。 .. rst-class:: classref-introduction-group 描述 ---- -最基本的 3D 游戏对象，具有 :ref:`Transform3D` 和可见性设置。所有其他的 3D 游戏对象都继承自 **Node3D**\ 。在 3D 项目中，请使用 **Node3D** 作为父节点对子节点进行移动、缩放、旋转和显示/隐藏。 +**Node3D** 节点是对位于 3D 空间中的节点基础表示，所有其他 3D 节点都继承自该类。 -除非该 **Node3D** 对象被设置为顶层，否则仿射操作（旋转、缩放、平移）会在父节点的本地坐标系中进行。在这个坐标系中的仿射操作对应于对 **Node3D** 变换的直接仿射运算。下文中的本地一词指的就是这个坐标系。附加到 **Node3D** 对象本身的坐标系被称为对象本地坐标系。 +除非该 **Node3D** 的 :ref:`top_level` 为 ``true``\ ，仿射操作（旋转、缩放、平移）的计算都使用相对于父节点的坐标系。在这一坐标系中，放射操作对应于该 **Node3D** 的 :ref:`transform` 的直接仿射运算。术语\ *父空间*\ 指的就是这个坐标系。附加到 **Node3D** 本身的坐标系被称为对象本地坐标系，即\ *局部空间*\ 。 -\ **注意：**\ 除非另有规定，所有有角度参数的方法必须将角度指定为\ *弧度*\ 。请使用 :ref:`@GlobalScope.deg_to_rad()` 将度数转换为弧度。 +\ **注意：**\ 除非另行说明，所有需要提供角度参数的方法收到的角度都必须以\ *弧度*\ 为单位。请使用 :ref:`@GlobalScope.deg_to_rad()` 将度数转换为弧度。 -\ **注意：**\ 请注意，从 Godot 4 开始，“Spatial”节点现在被称为“Node3D”。Godot 3.x 中指的“Spatial”节点，均指的是 Godot 4 中的“Node3D”。 +\ **注意：**\ Godot 3 及更早版本中，\ **Node3D** 的名字叫 *Spatial*\ （空间节点）。 .. rst-class:: classref-introduction-group @@ -181,7 +184,9 @@ Node3D **visibility_changed**\ (\ ) :ref:`🔗` -当节点可见性更改时触发。 +该节点的可见性发生改变时发出（见 :ref:`visible` 和 :ref:`is_visible_in_tree()`\ ）。 + +这个信号会在相关的 :ref:`NOTIFICATION_VISIBILITY_CHANGED` 通知\ *之后*\ 触发。 .. rst-class:: classref-section-separator @@ -204,7 +209,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`RotationEditMode` **ROTATION_EDIT_MODE_EULER** = ``0`` -旋转量以 :ref:`Vector3` 欧拉角的形式编辑。 +旋转量以 :ref:`Vector3` `欧拉角 `__\ 的形式编辑。 .. _class_Node3D_constant_ROTATION_EDIT_MODE_QUATERNION: @@ -220,7 +225,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`RotationEditMode` **ROTATION_EDIT_MODE_BASIS** = ``2`` -旋转量以 :ref:`Basis` 的形式编辑。此模式下无法单独编辑 :ref:`scale`\ 。 +旋转量以 :ref:`Basis` 的形式编辑。该模式下可以自由修改 :ref:`basis` 的轴，但 :ref:`scale` 属性不可用。 .. rst-class:: classref-section-separator @@ -237,9 +242,11 @@ enum **RotationEditMode**: :ref:`🔗` **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` -**Node3D** 节点在自己的全局变换发生改变时，会收到这个通知。这意味着当前节点或者某个父节点的变换发生了改变。 +如果 :ref:`is_transform_notification_enabled()` 为 ``true``\ ，该节点的 :ref:`global_transform` 发生改变时收到的通知。另见 :ref:`set_notify_transform()`\ 。 -用户需要使用 :ref:`set_notify_transform()` 手动申请才能够收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED`\ 。如果该节点在编辑器环境中，并且拥有至少一个有效的小工具，则也会发送这个通知。 +\ **注意：**\ :ref:`VisualInstance3D`\ 、\ :ref:`CollisionObject3D` 等大多数 3D 节点都会自动启用，从而正常工作。 + +\ **注意：**\ 在编辑器中，如果节点附加了小工具，就会将该通知传播给子节点（见 :ref:`add_gizmo()`\ ）。 .. _class_Node3D_constant_NOTIFICATION_ENTER_WORLD: @@ -247,7 +254,7 @@ enum **RotationEditMode**: :ref:`🔗` **NOTIFICATION_ENTER_WORLD** = ``41`` :ref:`🔗` -**Node3D** 节点在注册到新的 :ref:`World3D` 资源时，会收到这个通知。 +当该节点注册至新 :ref:`World3D` 时收到的通知（见 :ref:`get_world_3d()`\ ）。 .. _class_Node3D_constant_NOTIFICATION_EXIT_WORLD: @@ -255,7 +262,7 @@ enum **RotationEditMode**: :ref:`🔗` **NOTIFICATION_EXIT_WORLD** = ``42`` :ref:`🔗` -**Node3D** 节点从当前的 :ref:`World3D` 资源中取消注册时，会收到这个通知。 +当该节点取消注册至当前 :ref:`World3D` 时收到的通知（见 :ref:`get_world_3d()`\ ）。 .. _class_Node3D_constant_NOTIFICATION_VISIBILITY_CHANGED: @@ -263,7 +270,9 @@ enum **RotationEditMode**: :ref:`🔗` **NOTIFICATION_VISIBILITY_CHANGED** = ``43`` :ref:`🔗` -**Node3D** 节点在其可见性发生变化时，会收到该通知。 +节点的可见性发生改变时收到的通知（见 :ref:`visible` 和 :ref:`is_visible_in_tree()`\ ）。 + +该通知会在相关 :ref:`visibility_changed` 信号\ *之前*\ 收到。 .. _class_Node3D_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED: @@ -271,9 +280,9 @@ enum **RotationEditMode**: :ref:`🔗` **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``44`` :ref:`🔗` -**Node3D** 节点在其局部变换发生改变时，会收到这个通知。父节点的变换发生改变时不会收到这个通知。 +如果 :ref:`is_local_transform_notification_enabled()` 为 ``true``\ ，该节点的 :ref:`transform` 发生改变时收到的通知。父级 **Node3D** 节点的 :ref:`transform` 发生改变时不会受到该通知。另见 :ref:`set_notify_local_transform()`\ 。 -为了使 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` 起作用，用户首先需要使用 :ref:`set_notify_local_transform()` 请求它。 +\ **注意：**\ :ref:`CSGShape3D`\ 、\ :ref:`CollisionShape3D` 等部分节点会自动启用，从而正常工作。 .. rst-class:: classref-section-separator @@ -295,7 +304,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_basis**\ (\ value\: :ref:`Basis`\ ) - :ref:`Basis` **get_basis**\ (\ ) -:ref:`transform` 属性的基。代表该节点的旋转、缩放、倾斜。 +:ref:`transform` 属性的基。代表该节点在父空间中的旋转、缩放、倾斜（相对于父节点）。 .. rst-class:: classref-item-separator @@ -312,7 +321,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_global_basis**\ (\ value\: :ref:`Basis`\ ) - :ref:`Basis` **get_global_basis**\ (\ ) -这个节点的全局基。与 ``global_transform.basis`` 等价。 +:ref:`global_transform` 属性的基。代表该节点在全局空间中的旋转、缩放、倾斜（相对于世界）。 + +\ **注意：**\ 如果该节点不在树中，则获取该属性会失败并返回 :ref:`Basis.IDENTITY`\ 。 .. rst-class:: classref-item-separator @@ -329,7 +340,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_global_position**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_position**\ (\ ) -这个节点的全局位置。与 ``global_transform.origin`` 等价。 +该节点的全局位置（平移），使用全局空间（相对于世界）。等价于 :ref:`global_transform` 的 :ref:`Transform3D.origin`\ 。 + +\ **注意：**\ 如果该节点不在树中，则获取该属性会失败并返回 :ref:`Vector3.ZERO`\ 。 .. rst-class:: classref-item-separator @@ -346,9 +359,17 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_global_rotation**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_rotation**\ (\ ) -全局变换的旋转部分，单位为弧度，以 YXZ 欧拉角的形式表示（X 角、Y 角、Z 角）。 +该节点的全局旋转\ `欧拉角 `__\ ，单位为弧度，使用全局空间（相对于世界）。该值获取自 :ref:`global_basis` 的旋转。 -\ **注意：**\ 在数学意义上，旋转是一个矩阵而不是一个向量。这三个欧拉角是旋转矩阵欧拉角参数化的三个独立参数，存储在 :ref:`Vector3` 数据结构中并不是因为旋转是一个矢量，而是因为 :ref:`Vector3` 是一种方便存储 3 个浮点数的数据结构。因此，对旋转“向量”应用仿射操作是没有意义的。 +- :ref:`Vector3.x` 包含围绕全局 X 轴的角度（俯仰）。 + +- :ref:`Vector3.y` 包含围绕全局 Y 轴的角度（偏摆）。 + +- :ref:`Vector3.z` 包含围绕全局 Z 轴的角度（翻滚）。 + +\ **注意：**\ 与 :ref:`rotation` 不同，该属性始终使用 YXZ 约定（\ :ref:`@GlobalScope.EULER_ORDER_YXZ`\ ）。 + +\ **注意：**\ 如果该节点不在树中，则获取该属性会失败并返回 :ref:`Vector3.ZERO`\ 。 .. rst-class:: classref-item-separator @@ -365,7 +386,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_global_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_rotation_degrees**\ (\ ) -辅助属性，用于按度数访问 :ref:`global_rotation` 而不是弧度数。 +该节点的 :ref:`global_rotation`\ ，但单位为角度而非弧度。 + +\ **注意：**\ 如果该节点不在树中，则获取该属性会失败并返回 :ref:`Vector3.ZERO`\ 。 .. rst-class:: classref-item-separator @@ -382,7 +405,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_global_transform**\ (\ value\: :ref:`Transform3D`\ ) - :ref:`Transform3D` **get_global_transform**\ (\ ) -该节点在 World3D 空间的（全局）\ :ref:`Transform3D`\ 。 +该节点的变换，使用全局空间（相对于世界）。包含并代表该节点的 :ref:`global_position`\ 、\ :ref:`global_rotation` 以及全局缩放。 + +\ **注意：**\ 如果该节点不在树中，则获取该属性会失败并返回 :ref:`Transform3D.IDENTITY`\ 。 .. rst-class:: classref-item-separator @@ -399,7 +424,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_position**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_position**\ (\ ) -该节点相对于父节点的局部位置或平移。相当于 ``transform.origin``\ 。 +该节点的位置（平移），使用父空间（相对于父节点）。等价于 :ref:`transform` 的 :ref:`Transform3D.origin`\ 。 .. rst-class:: classref-item-separator @@ -416,7 +441,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_quaternion**\ (\ value\: :ref:`Quaternion`\ ) - :ref:`Quaternion` **get_quaternion**\ (\ ) -以一个 :ref:`Quaternion` 的形式访问该节点的旋转。该属性非常适合补间复杂的旋转。 +该节点的旋转，以父空间中的四元数 :ref:`Quaternion` 的形式显示（相对于父节点）。该值获取自 :ref:`basis` 的旋转。 + +\ **注意：**\ 四元数更适合 3D 数学运算，但相对不那么直观。设置该属性可能适用于插值（见 :ref:`Quaternion.slerp()`\ ）。 .. rst-class:: classref-item-separator @@ -433,11 +460,17 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_rotation**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_rotation**\ (\ ) -以弧度为单位的，局部变换的旋转部分，根据欧拉角指定。角度按照 :ref:`rotation_order` 属性指定的顺序，构造一个旋转。 +该节点的旋转\ `欧拉角 `__\ ，单位为弧度，使用父空间（相对于父节点）。该值获取自 :ref:`basis` 的旋转。 -\ **注意：**\ 在数学意义上，旋转是一个矩阵，而不是一个向量。三个欧拉角，即旋转矩阵的欧拉角参数化的三个独立参数，存储在一个 :ref:`Vector3` 数据结构中，并不是因为旋转是一个向量，而是因为 :ref:`Vector3` 是一个方便存储 3 个浮点数的数据结构。因此，对旋转“向量”，应用仿射操作是没有意义的。 +- :ref:`Vector3.x` 包含围绕局部 X 轴的角度（俯仰）。 -\ **注意：**\ 该属性在检查器中以度为单位进行编辑。如果要在脚本中使用度数，请使用 :ref:`rotation_degrees`\ 。 +- :ref:`Vector3.y` 包含围绕局部 Y 轴的角度（偏摆）。 + +- :ref:`Vector3.z` 包含围绕局部 Z 轴的角度（翻滚）。 + +连续旋转的顺序可以通过 :ref:`rotation_order` 修改（见 :ref:`EulerOrder` 常量）。默认使用 YXZ 约定（\ :ref:`@GlobalScope.EULER_ORDER_YXZ`\ ）。 + +\ **注意：**\ 该属性在检查器中以度数为单位进行编辑。如果你想要在脚本中使用度数，请使用 :ref:`rotation_degrees`\ 。 .. rst-class:: classref-item-separator @@ -454,7 +487,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_rotation_degrees**\ (\ ) -辅助属性，用于按度数访问 :ref:`rotation` 而不是弧度数。 +该节点的 :ref:`rotation`\ ，但单位为角度而非弧度。 + +\ **注意：**\ 这\ **不是**\ 检查器面板中的那个属性。 .. rst-class:: classref-item-separator @@ -471,7 +506,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_rotation_edit_mode**\ (\ value\: :ref:`RotationEditMode`\ ) - :ref:`RotationEditMode` **get_rotation_edit_mode**\ (\ ) -指定旋转（和缩放）在编辑器中的显示方式。 +该节点的旋转和缩放在检查器面板中的显示方式。 .. rst-class:: classref-item-separator @@ -488,7 +523,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_rotation_order**\ (\ value\: :ref:`EulerOrder`\ ) - :ref:`EulerOrder` **get_rotation_order**\ (\ ) -指定 :ref:`rotation` 属性的轴旋转顺序。最终的方向是通过按该属性指定的顺序旋转欧拉角来构建的。 +:ref:`rotation` 属性的轴旋转顺序。最终的朝向是通过按此处指定的顺序对局部 X 轴、局部 Y 轴、局部 Z 轴进行旋转来计算的。 .. rst-class:: classref-item-separator @@ -505,11 +540,11 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_scale**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_scale**\ (\ ) -局部变换的缩放部分。 +该节点的缩放，使用局部空间（相对于该节点）。该值获取自 :ref:`basis` 的缩放。 -\ **注意：**\ 3D 中，变换矩阵是无法分解出正负混合的缩放的。由于 Godot 中使用变换矩阵来表示缩放，得到的缩放值要么全正、要么全负。 +\ **注意：**\ 部分 3D 节点类型的行为不受该属性的影响。例如 :ref:`Light3D`\ 、\ :ref:`Camera3D`\ 、\ :ref:`AudioStreamPlayer3D` 等。 -\ **注意：**\ 并不是所有节点的外观都会被 :ref:`scale` 属性缩放。例如，\ :ref:`Light3D` 的外观就不受 :ref:`scale` 影响。 +\ **警告：**\ 各缩放分量的正负必须一致，并且\ **不能**\ 完全等于 ``0.0``\ 。否则无法从 :ref:`basis` 获取该缩放值，可能导致所需的缩放在从磁盘重新加载后丢失，以及其他潜在的不稳定行为。 .. rst-class:: classref-item-separator @@ -526,7 +561,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_as_top_level**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_set_as_top_level**\ (\ ) -如果为 ``true``\ ，则该节点将不会从其父节点继承其变换。节点变换仅在全局空间中。 +如果为 ``true``\ ，则该节点不会继承其父节点的变换。因此，节点的变换只会在全局空间中进行，同时也意味着 :ref:`global_transform` 和 :ref:`transform` 完全一致。 .. rst-class:: classref-item-separator @@ -543,7 +578,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) - :ref:`Transform3D` **get_transform**\ (\ ) -该节点的局部空间 :ref:`Transform3D`\ ，相对于父节点。 +该节点的局部变换，使用父空间（相对于父节点）。包含并代表该节点的 :ref:`position`\ 、\ :ref:`rotation` 以及 :ref:`scale`\ 。 .. rst-class:: classref-item-separator @@ -560,7 +595,9 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_visibility_parent**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_visibility_parent**\ (\ ) -定义该节点及其子树的可见性范围父级。可见性父级必须是一个 GeometryInstance3D。仅当可见性父级（及其所有可见性祖先）通过比其自身 :ref:`GeometryInstance3D.visibility_range_begin` 更靠近相机而被隐藏时，任何视觉实例才会可见。通过 :ref:`visible` 属性隐藏的节点，基本上可以从可见性依赖树中移除，因此依赖实例不会考虑隐藏节点或其祖先。 +该节点及其子级的可见性范围父级。可见性父级必须是一个 :ref:`GeometryInstance3D`\ 。 + +仅当可见性父级节点（及其所有可见性祖级节点）因为与相机的距离比其自身 :ref:`GeometryInstance3D.visibility_range_begin` 更近而被隐藏时，视觉实例才会可见。通过 :ref:`visible` 属性隐藏的节点，可以看作被从可见性依赖树中移除，因此依赖实例不会考虑隐藏节点或其祖级节点。 .. rst-class:: classref-item-separator @@ -577,7 +614,7 @@ enum **RotationEditMode**: :ref:`🔗` - |void| **set_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_visible**\ (\ ) -如果为 ``true``\ ，这个节点就会被画出来。只有当它的所有前项也是可见的时候，这个节点才是可见的（换句话说，\ :ref:`is_visible_in_tree()` 必须返回 ``true``\ ）。 +如果为 ``true``\ ，则该节点能否显示。只有当所有祖先节点都是可见的时候，这个节点才可见。换句话说，\ :ref:`is_visible_in_tree()` 必须返回 ``true``\ 。 .. rst-class:: classref-section-separator @@ -594,9 +631,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo`\ ) :ref:`🔗` -将编辑器小工具附加到该 **Node3D**\ 。 +将小工具 ``gizmo`` 附加至该节点。仅在编辑器中有效。 -\ **注意：**\ 小工具对象通常是 :ref:`EditorNode3DGizmo` 的一个实例，但参数类型保持通用以避免在 **Node3D** 中创建对编辑器类的依赖。 +\ **注意：**\ ``gizmo`` 应为 :ref:`EditorNode3DGizmo`\ 。参数类型使用 :ref:`Node3DGizmo` 是为了避免在 **Node3D** 中对编辑器类产生依赖。 .. rst-class:: classref-item-separator @@ -608,7 +645,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **clear_gizmos**\ (\ ) :ref:`🔗` -清除附加于该 **Node3D** 的所有小工具。 +清空所有附加到该节点的 :ref:`EditorNode3DGizmo` 对象。仅在编辑器中生效。 .. rst-class:: classref-item-separator @@ -620,7 +657,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **clear_subgizmo_selection**\ (\ ) :ref:`🔗` -在编辑器中，清除该节点的子小工具选择。在一个属性更改后，子小工具 ID 变得无效时很有用。 +取消选中该节点的所有子小工具。适用于选中的子小工具在属性发生改变后不再存在的情况。仅在编辑器中有效。 .. rst-class:: classref-item-separator @@ -632,7 +669,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **force_update_transform**\ (\ ) :ref:`🔗` -强制更新变换。由于性能原因，物理中的变换改变不是即时的。变换是在累积后再设置。如果你在进行物理操作时需要最新的变换，请使用此功能。 +发送 :ref:`NOTIFICATION_TRANSFORM_CHANGED`\ ，强制更新该节点的 :ref:`global_transform`\ 。如果该节点不在树中则失败。 + +\ **注意：**\ 出于性能原因，变换的更改通常会累积到一帧的末尾进行\ *单次*\ 应用。更新还会传播至 **Node3D** 子节点。因此，请仅在需要最新变换时使用该方法（例如在物理操作期间）。 .. rst-class:: classref-item-separator @@ -644,7 +683,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`Array`\[:ref:`Node3DGizmo`\] **get_gizmos**\ (\ ) |const| :ref:`🔗` -返回附加到该 **Node3D** 的所有小工具。 +返回附加于该节点的所有 :ref:`EditorNode3DGizmo` 对象。仅在编辑器中有效。 .. rst-class:: classref-item-separator @@ -672,9 +711,9 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`Node3D` **get_parent_node_3d**\ (\ ) |const| :ref:`🔗` -返回 **Node3D** 父节点，如果没有父节点、父节点不是 **Node3D** 类型或 :ref:`top_level` 为 ``true``\ ，则返回 ``null``\ 。 +返回直接对该节点的 :ref:`global_transform` 产生影响的父级 **Node3D** 节点。如果不存在父节点、父节点不是 **Node3D** 或 :ref:`top_level` 为 ``true`` 则返回 ``null``\ 。 -\ **注意：**\ 调用这个方法并不等价于 ``get_parent() as Node3D``\ ，后者不会考虑 :ref:`top_level`\ 。 +\ **注意：**\ 该方法并不总是等价于 :ref:`Node.get_parent()`\ ，后者不会考虑 :ref:`top_level`\ 。 .. rst-class:: classref-item-separator @@ -686,7 +725,9 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`World3D` **get_world_3d**\ (\ ) |const| :ref:`🔗` -返回此 **Node3D** 节点所注册的当前 :ref:`World3D` 资源。 +返回该节点注册到的 :ref:`World3D`\ 。 + +通常与该节点视口的世界一致（见 :ref:`Node.get_viewport()` 和 :ref:`Viewport.find_world_3d()`\ ）。 .. rst-class:: classref-item-separator @@ -698,7 +739,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **global_rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -将全局（世界）变换围绕某个轴（单位 :ref:`Vector3`\ ）旋转指定的弧度。旋转轴使用全局坐标系。 +将该节点的 :ref:`global_basis` 绕全局轴 ``axis`` 旋转，旋转弧度为 ``angle``\ 。该操作所涉及的计算在全局空间中进行（相对于世界），\ :ref:`global_position` 保持不变。 .. rst-class:: classref-item-separator @@ -710,7 +751,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **global_scale**\ (\ scale\: :ref:`Vector3`\ ) :ref:`🔗` -将全局（世界）变换按照给定的 :ref:`Vector3` 缩放因子进行缩放。 +使用 ``scale`` 中给定的缩放系数对该节点的 :ref:`global_basis` 进行缩放。该操作所设计的计算在全局空间中进行（相对于世界），\ :ref:`global_position` 保持不变。 + +\ **注意：**\ 请勿将该方法与 :ref:`scale` 属性混淆。 .. rst-class:: classref-item-separator @@ -722,7 +765,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **global_translate**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` -将全局（世界）变换按照 :ref:`Vector3` 偏移量进行移动。偏移量使用全局坐标系。 +向该节点的 :ref:`global_position` 添加 ``offset`` 中指定的全局空间平移偏移量（相对于世界）。 .. rst-class:: classref-item-separator @@ -734,7 +777,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **hide**\ (\ ) :ref:`🔗` -禁用该节点的渲染。会将 :ref:`visible` 改为 ``false``\ 。 +阻止渲染该节点。等价于将 :ref:`visible` 设置为 ``false``\ 。该方法与 :ref:`show()` 相对。 .. rst-class:: classref-item-separator @@ -746,7 +789,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -返回该节点是否通知其局部变换的更改。\ **Node3D** 默认不会传播此属性。 +如果该节点会在 :ref:`transform` 改变时收到 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` 则返回 ``true``\ 。可以通过 :ref:`set_notify_local_transform()` 启用这一行为。 .. rst-class:: classref-item-separator @@ -758,7 +801,9 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`bool` **is_scale_disabled**\ (\ ) |const| :ref:`🔗` -返回该节点是否使用 ``(1, 1, 1)`` 的比例或其本地变换比例。 +如果该节点的 :ref:`global_transform` 会自动进行正交归一化，则返回 ``true``\ 。正交归一化的节点不会变形，效果与全局缩放为 :ref:`Vector3.ONE`\ （或对应的负值）一致。另见 :ref:`is_scale_disabled()` 和 :ref:`orthonormalize()`\ 。 + +\ **注意：**\ 该设置不影响 :ref:`transform`\ 。 .. rst-class:: classref-item-separator @@ -770,7 +815,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -返回该节点是否通知其全局和局部变换的更改。\ **Node3D** 默认不会传播此属性。 +如果该节点会在 :ref:`global_transform` 改变时收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED` 则返回 ``true``\ 。可以通过 :ref:`set_notify_transform()` 启用这一行为。 .. rst-class:: classref-item-separator @@ -782,11 +827,9 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` -如果节点存在于 :ref:`SceneTree` 中，并且 :ref:`visible` 属性为 ``true``\ 、所有祖级节点也都可见，则返回 ``true``\ 。如果存在隐藏的祖级节点，则该节点在场景树中不可见。 +如果该节点位于场景树中且该节点及其所有\ *连续的* **Node3D** 祖先节点的 :ref:`visible` 属性均为 ``true``\ ，则返回 ``true``\ 。其他类型的祖先节点（例如 :ref:`Node`\ 、\ :ref:`Node2D`\ ）都会打断连续。另见 :ref:`Node.get_parent()`\ 。 -父节点派生自 **Node3D** 时才会进行可见性检查。如果父节点为其他类型（例如 :ref:`Node`\ 、\ :ref:`AnimationPlayer`\ 、\ :ref:`Node2D`\ ），则会当作可见。 - -\ **注意：**\ 该方法不会考虑 :ref:`VisualInstance3D.layers`\ ，因此即便返回 ``true``\ ，最后也可能不渲染该节点。 +\ **注意：**\ 该方法无法考虑 :ref:`VisualInstance3D.layers`\ ，因此即便该方法返回 ``true``\ ，也可能不渲染该节点。 .. rst-class:: classref-item-separator @@ -798,18 +841,16 @@ enum **RotationEditMode**: :ref:`🔗` |void| **look_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` -旋转该节点，让局部向前的轴（-Z，\ :ref:`Vector3.FORWARD`\ ）指向 ``target`` 的位置。 +旋转该节点，让局部向前的轴（-Z，\ :ref:`Vector3.FORWARD`\ ）指向 ``target`` 的位置。该操作所涉及的运算在全局空间中进行（相对于世界）。 局部向上的轴（+Y）在保持与局部向前的轴垂直的前提下，尽可能接近 ``up`` 向量。最终的变换是正交变换，并且保留了原有缩放。非统一缩放可能无法正常工作。 -\ ``target`` 位置不能和该节点的位置相同，\ ``up`` 向量不能为零。 - -\ ``target`` 和 ``up`` 不能为 :ref:`Vector3.ZERO`\ ，两者也不能共线，这样可以避免围绕局部 Z 轴发生预料之外的旋转。 - -操作发生在全局空间，也就是说该节点必须位于场景树中。 +\ ``target`` 位置不能和该节点的位置相同，\ ``up`` 向量不能为 :ref:`Vector3.ZERO`\ 。此外，节点位置到 ``target`` 位置的方向不能与 ``up`` 向量平行，这样可以避免围绕局部 Z 轴发生预料之外的旋转。 如果 ``use_model_front`` 为 ``true``\ ，则会将 +Z 轴（资产正面）作为向前的轴（此时 +X 为左），指向 ``target`` 的位置。默认情况下会将 -Z 轴（相机前方）作为向前的轴（此时 +X 为右）。 +\ **注意：**\ 如果该节点不在场景树中，则该方法失败。必要时请改用 :ref:`look_at_from_position()`\ 。 + .. rst-class:: classref-item-separator ---- @@ -820,7 +861,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **look_at_from_position**\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` -将节点移动到指定的 ``position``\ ，然后根据 :ref:`look_at()` 旋转该节点以指向 ``target``\ 。操作发生在全局空间中。 +将该节点移动到 ``position`` 位置，然后旋转至指向 ``target`` 位置，类似于 :ref:`look_at()`\ 。操作发生在全局空间中（相对于世界）。 .. rst-class:: classref-item-separator @@ -832,7 +873,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **orthonormalize**\ (\ ) :ref:`🔗` -通过在该节点的 :ref:`Transform3D` 上执行 Gram-Schmidt 正交归一化，重置该节点的变换（如缩放、倾斜和锥度），以保留其旋转和平移。 +将该节点的 :ref:`basis` 进行正交归一化。该方法会将该节点的 :ref:`scale` 设置为 :ref:`Vector3.ONE`\ （或对应的负值），保持 :ref:`position` 和 :ref:`rotation` 不变。另见 :ref:`Transform3D.orthonormalized()`\ 。 .. rst-class:: classref-item-separator @@ -844,7 +885,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -围绕轴（单位 :ref:`Vector3`\ ）旋转局部变换，指定角度（弧度）。 +将节点的 :ref:`basis` 绕 ``axis`` 轴旋转，旋转角 ``angle`` 的单位为弧度。该操作在父空间中进行计算（相对于父节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -856,7 +897,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **rotate_object_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -围绕轴（单位 :ref:`Vector3`\ ）旋转局部变换，指定角度（弧度）。旋转轴是在物体的本地坐标系中。 +将节点的 :ref:`basis` 绕 ``axis`` 轴旋转，旋转角 ``angle`` 的单位为弧度。该操作在局部空间中进行计算（相对于该节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -868,7 +909,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **rotate_x**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` -围绕 X 轴旋转局部变换，旋转角度为弧度。 +将节点的 :ref:`basis` 绕 X 轴旋转，旋转角 ``angle`` 的单位为弧度。该操作在父空间中进行计算（相对于父节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -880,7 +921,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **rotate_y**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` -围绕 Y 轴旋转局部变换，旋转角度为弧度。 +将节点的 :ref:`basis` 绕 Y 轴旋转，旋转角 ``angle`` 的单位为弧度。该操作在父空间中进行计算（相对于父节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -892,7 +933,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **rotate_z**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` -围绕 Z 轴旋转局部变换，旋转角度为弧度。 +将节点的 :ref:`basis` 绕 Z 轴旋转，旋转角 ``angle`` 的单位为弧度。该操作在父空间中进行计算（相对于父节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -904,7 +945,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **scale_object_local**\ (\ scale\: :ref:`Vector3`\ ) :ref:`🔗` -在物体局部坐标系中，通过给定的 3D 比例因子来缩放局部变换。 +将节点的 :ref:`basis` 进行缩放，缩放系数为 ``scale``\ 。该操作在局部空间中进行计算（相对于该节点），\ :ref:`position` 保持不变。 .. rst-class:: classref-item-separator @@ -916,7 +957,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_disable_scale**\ (\ disable\: :ref:`bool`\ ) :ref:`🔗` -设置节点是否使用 ``(1, 1, 1)`` 的比例或其本地变换比例。对本地变换比例的改变会被保留下来。 +如果为 ``true``\ ，则该节点的 :ref:`global_transform` 会自动进行正交归一化。正交归一化的节点不会变形，效果与全局缩放为 :ref:`Vector3.ONE`\ （或对应的负值）一致。另见 :ref:`is_scale_disabled()` 和 :ref:`orthonormalize()`\ 。 + +\ **注意：**\ 该设置不影响 :ref:`transform`\ 。 .. rst-class:: classref-item-separator @@ -928,7 +971,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_identity**\ (\ ) :ref:`🔗` -重置此节点的所有变换（将其 :ref:`Transform3D` 设置为单位矩阵）。 +将该节点的 :ref:`transform` 设置为 :ref:`Transform3D.IDENTITY`\ ，会重置父空间中的所有变换（\ :ref:`position`\ 、\ :ref:`rotation`\ 、\ :ref:`scale`\ ）。 .. rst-class:: classref-item-separator @@ -940,7 +983,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_ignore_transform_notification**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` -设置该节点是否忽略其转换（全局或局部）改变的通知。 +如果为 ``true``\ ，则该节点不会收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED` 和 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`\ 。 + +适用于在处理这些通知时阻止无限递归。 .. rst-class:: classref-item-separator @@ -952,7 +997,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -设置该节点是否通知其局部变换的更改。\ **Node3D** 默认不会传播此属性。 +如果为 ``true``\ ，则该节点会在 :ref:`transform` 发生变化时收到 :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`\ 。 + +\ **注意：**\ :ref:`CSGShape3D`\ 、\ :ref:`CollisionShape3D` 等部分 3D 节点会自动启用，从而正常工作。 .. rst-class:: classref-item-separator @@ -964,7 +1011,11 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -设置该节点是否通知其全局和局部变换的更改。\ **Node3D** 默认不会传播此属性，除非位于编辑器上下文中，并且存在有效的小工具。 +如果为 ``true``\ ，则该节点会在 :ref:`global_transform` 发生变化时收到 :ref:`NOTIFICATION_TRANSFORM_CHANGED`\ 。 + +\ **注意：**\ :ref:`VisualInstance3D`\ 、\ :ref:`CollisionObject3D` 等大多数 3D 节点会自动启用，从而正常工作。 + +\ **注意：**\ 在编辑器中，如果节点附加了小工具，就会将该通知传播给子节点（见 :ref:`add_gizmo()`\ ）。 .. rst-class:: classref-item-separator @@ -976,9 +1027,9 @@ enum **RotationEditMode**: :ref:`🔗` |void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` -在编辑器中为该节点设置子小工具选区。 +选中小工具 ``gizmo`` 的 ID 为 ``id`` 的子小工具，并设置其变换。仅在编辑器中有效。 -\ **注意：**\ 小工具对象通常是 :ref:`EditorNode3DGizmo` 的一个实例，但参数类型保持通用以避免在 **Node3D** 中创建对编辑器类的依赖。 +\ **注意：**\ 小工具对象通常是 :ref:`EditorNode3DGizmo` 的实例，但参数类型保持通用以避免在 **Node3D** 中创建对编辑器类的依赖。 .. rst-class:: classref-item-separator @@ -990,7 +1041,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **show**\ (\ ) :ref:`🔗` -启用此节点的呈现。将 :ref:`visible` 更改为 ``true``\ 。 +允许渲染该节点。等价于将 :ref:`visible` 设置为 ``true``\ 。该方法与 :ref:`hide()` 相对。 .. rst-class:: classref-item-separator @@ -1002,7 +1053,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`Vector3` **to_global**\ (\ local_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -将 ``local_point`` 从这个节点的局部空间转换为世界空间。 +返回将 ``local_point`` 从该节点的局部空间转换至全局空间的结果。该方法与 :ref:`to_local()` 相对。 .. rst-class:: classref-item-separator @@ -1014,7 +1065,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`Vector3` **to_local**\ (\ global_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -将 ``global_point`` 从世界空间转换到这个节点的局部空间。 +返回将 ``global_point`` 从全局空间转换至该节点的局部空间的结果。该方法与 :ref:`to_global()` 相对。 .. rst-class:: classref-item-separator @@ -1026,9 +1077,11 @@ enum **RotationEditMode**: :ref:`🔗` |void| **translate**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` -通过给定的偏移量 :ref:`Vector3` 更改该节点的位置。 +向该节点的位置添加平移偏移量 ``offset``\ ，使用局部空间（相对于该节点）。 -请注意，平移 ``offset`` 受节点缩放的影响，因此如果按例如 ``(10, 1, 1)`` 的比例缩放，那么偏移 ``(2, 0, 0)`` 的平移，实际上会在 X 坐标上增加 20（\ ``2 * 10``\ ）。 +\ **注意：**\ 请优先使用 :ref:`translate_object_local()`\ ，因为本方法可能在后续版本中发生改变。 + +\ **注意：**\ 该操作所涉及的运算\ **不是**\ 在父空间中进行的，这与该方法的命名方式不一致是处于兼容考虑。要在父空间中进行平移请向 :ref:`position` 添加 ``offset``\ （\ ``node_3d.position += offset``\ ）。 .. rst-class:: classref-item-separator @@ -1040,7 +1093,7 @@ enum **RotationEditMode**: :ref:`🔗` |void| **translate_object_local**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` -通过给定的局部空间偏移量 :ref:`Vector3` 改变该节点的位置。 +向该节点的位置添加平移偏移量 ``offset``\ ，使用局部空间（相对于该节点）。 .. rst-class:: classref-item-separator @@ -1052,9 +1105,10 @@ enum **RotationEditMode**: :ref:`🔗` |void| **update_gizmos**\ (\ ) :ref:`🔗` -更新附加于该节点的所有 **Node3D** 小工具。 +更新附加于该节点的所有 :ref:`EditorNode3DGizmo` 小工具。仅在编辑器中有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_node3dgizmo.rst b/classes/zh_CN/class_node3dgizmo.rst index 1c778d629c..0ccd4bf518 100644 --- a/classes/zh_CN/class_node3dgizmo.rst +++ b/classes/zh_CN/class_node3dgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Node3DGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node3DGizmo.xml. .. _class_Node3DGizmo: @@ -26,6 +26,7 @@ Node3DGizmo \ **Node3DGizmo** 本身没有公开的 API，请参考 :ref:`Node3D.add_gizmo()` 并向其传递一个 :ref:`EditorNode3DGizmo` 实例。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_nodepath.rst b/classes/zh_CN/class_nodepath.rst index e636b3ec76..f96453b140 100644 --- a/classes/zh_CN/class_nodepath.rst +++ b/classes/zh_CN/class_nodepath.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/NodePath.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NodePath.xml. .. _class_NodePath: @@ -177,18 +177,18 @@ NodePath # 指向 Sprite2D 节点。 "Level/RigidBody2D/Sprite2D" - + # 指向 Sprite2D 节点及其“纹理（texture）”资源。 # get_node() 将检索 Sprite2D，而 get_node_and_resource() # 将同时检索该 Sprite2D 节点和其“纹理（texture）”资源。 "Level/RigidBody2D/Sprite2D:texture" - + # 指向 Sprite2D 节点及其“位置（position）”属性。 "Level/RigidBody2D/Sprite2D:position" - + # 指向 Sprite2D 节点及其“位置（position）”属性的 “x” 分量。 "Level/RigidBody2D/Sprite2D:position:x" - + # 指向 RigidBody2D 节点作为从 SceneTree 开始的绝对路径。 "/root/Level/RigidBody2D" @@ -218,7 +218,7 @@ NodePath # node_path 指向名为 “position” 的子节点的 “x” 属性。 var node_path = ^"position:x" - + # property_path 指向该节点在 “x” 轴上的 “position”。 var property_path = node_path.get_as_property_path() print(property_path) # 输出“:position:x” @@ -227,7 +227,7 @@ NodePath // node_path 指向名为 “position” 的子节点的 “x” 属性。 var nodePath = new NodePath("position:x"); - + // property_path 指向该节点在 “x” 轴上的 “position”。 NodePath propertyPath = nodePath.GetAsPropertyPath(); GD.Print(propertyPath); // 输出“:position:x” @@ -445,6 +445,7 @@ NodePath 如果两个节点路径相等，即它们由相同的节点名称和子名称按相同的顺序组成，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_noise.rst b/classes/zh_CN/class_noise.rst index 0cbb73a23b..8f6dd3e411 100644 --- a/classes/zh_CN/class_noise.rst +++ b/classes/zh_CN/class_noise.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/noise/doc_classes/Noise.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/Noise.xml. .. _class_Noise: @@ -177,6 +177,7 @@ Noise \ **注意：**\ ``normalize`` 为 ``false`` 时，默认实现要求噪声生成器返回 ``-1.0`` 到 ``1.0`` 之间的值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_noisetexture2d.rst b/classes/zh_CN/class_noisetexture2d.rst index a18d9534c5..f14a9d503b 100644 --- a/classes/zh_CN/class_noisetexture2d.rst +++ b/classes/zh_CN/class_noisetexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/noise/doc_classes/NoiseTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/NoiseTexture2D.xml. .. _class_NoiseTexture2D: @@ -287,6 +287,7 @@ NoiseTexture2D 生成的纹理的宽度（单位为像素）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_noisetexture3d.rst b/classes/zh_CN/class_noisetexture3d.rst index 7a6ab6a861..af0d7b67e2 100644 --- a/classes/zh_CN/class_noisetexture3d.rst +++ b/classes/zh_CN/class_noisetexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/noise/doc_classes/NoiseTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/NoiseTexture3D.xml. .. _class_NoiseTexture3D: @@ -225,6 +225,7 @@ NoiseTexture3D 生成的纹理的宽度（单位为像素）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_object.rst b/classes/zh_CN/class_object.rst index 68c38c0d27..5a441d24e1 100644 --- a/classes/zh_CN/class_object.rst +++ b/classes/zh_CN/class_object.rst @@ -2,15 +2,15 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Object.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Object.xml. .. _class_Object: Object ====== -**派生：** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` +**派生：** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapper`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` 引擎中所有其他类的基类。 @@ -274,6 +274,14 @@ enum **ConnectFlags**: :ref:`🔗` 引用计数连接可以多次分配给同一个 :ref:`Callable`\ 。每断开一次连接会让内部计数器减一。信号会在计数器变为 0 时完全断开连接。 +.. _class_Object_constant_CONNECT_APPEND_SOURCE_OBJECT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ConnectFlags` **CONNECT_APPEND_SOURCE_OBJECT** = ``16`` + +实例化 :ref:`PackedScene` 时会自动绑定来源对象。如果启用该标志位，则来源对象会追加至信号原参数的右侧。 + .. rst-class:: classref-section-separator ---- @@ -324,7 +332,9 @@ enum **ConnectFlags**: :ref:`🔗` 覆盖该方法以自定义 :ref:`get()` 的行为。应该返回给定的 ``property`` 的值，或者 ``property`` 应该被正常处理时返回 ``null``\ 。 -结合 :ref:`_set()` 和 :ref:`_get_property_list()`\ ，该方法允许定义自定义属性，这对编辑器插件特别有用。请注意，属性必须存在于 :ref:`get_property_list()` 中，否则该方法不会被调用。 +结合 :ref:`_set()` 和 :ref:`_get_property_list()`\ ，该方法允许定义自定义属性，对编辑器插件特别有用。 + +\ **注意：**\ 获取对象的内置属性时不会调用该方法，包括使用 :ref:`@GDScript.@export` 定义的属性。 .. tabs:: @@ -335,7 +345,7 @@ enum **ConnectFlags**: :ref:`🔗` if property == "fake_property": print("正在获取我的属性！") return 4 - + func _get_property_list(): return [ { "name": "fake_property", "type": TYPE_INT } @@ -352,7 +362,7 @@ enum **ConnectFlags**: :ref:`🔗` } return default; } - + public override Godot.Collections.Array _GetPropertyList() { return @@ -392,18 +402,18 @@ enum **ConnectFlags**: :ref:`🔗` @tool extends Node - + @export var number_count = 3: set(nc): number_count = nc numbers.resize(number_count) notify_property_list_changed() - + var numbers = PackedInt32Array([0, 0, 0]) - + func _get_property_list(): var properties = [] - + for i in range(number_count): properties.append({ "name": "number_%d" % i, @@ -411,14 +421,14 @@ enum **ConnectFlags**: :ref:`🔗` "hint": PROPERTY_HINT_ENUM, "hint_string": "ZERO,ONE,TWO,THREE,FOUR,FIVE", }) - + return properties - + func _get(property): if property.begins_with("number_"): var index = property.get_slice("_", 1).to_int() return numbers[index] - + func _set(property, value): if property.begins_with("number_"): var index = property.get_slice("_", 1).to_int() @@ -432,7 +442,7 @@ enum **ConnectFlags**: :ref:`🔗` public partial class MyNode : Node { private int _numberCount; - + [Export] public int NumberCount { @@ -444,13 +454,13 @@ enum **ConnectFlags**: :ref:`🔗` NotifyPropertyListChanged(); } } - + private Godot.Collections.Array _numbers = []; - + public override Godot.Collections.Array _GetPropertyList() { Godot.Collections.Array properties = []; - + for (int i = 0; i < _numberCount; i++) { properties.Add(new Godot.Collections.Dictionary() @@ -461,10 +471,10 @@ enum **ConnectFlags**: :ref:`🔗` { "hint_string", "Zero,One,Two,Three,Four,Five" }, }); } - + return properties; } - + public override Variant _Get(StringName property) { string propertyName = property.ToString(); @@ -475,7 +485,7 @@ enum **ConnectFlags**: :ref:`🔗` } return default; } - + public override bool _Set(StringName property, Variant value) { string propertyName = property.ToString(); @@ -521,6 +531,8 @@ enum **ConnectFlags**: :ref:`🔗` 返回当前的可迭代值。\ ``iter`` 存储迭代状态，但与 :ref:`_iter_init()` 和 :ref:`_iter_next()` 不同，此处的状态只读，因此不使用 :ref:`Array` 封装。 +\ **贴士：**\ 在 GDScript 中，你可以使用 :ref:`Variant` 子类型作为 :ref:`_iter_get()` 的返回类型。该类型会用来设置 ``for`` 循环中迭代器变量的类型，提升类型安全。 + .. rst-class:: classref-item-separator ---- @@ -531,32 +543,30 @@ enum **ConnectFlags**: :ref:`🔗` :ref:`bool` **_iter_init**\ (\ iter\: :ref:`Array`\ ) |virtual| :ref:`🔗` -初始化迭代器。\ ``iter`` 存储迭代状态。由于 GDScript 不支持按引用传递参数，这里使用单元素数组作为包装器。只要迭代器尚未到达末尾就会返回 ``true``\ 。 - -实例： +初始化迭代器。\ ``iter`` 存储迭代状态。由于 GDScript 不支持按引用传递参数，这里使用单个元素的数组作为包装器。只要迭代器尚未到达末尾就会返回 ``true``\ 。 :: class MyRange: var _from var _to - + func _init(from, to): assert(from <= to) _from = from _to = to - + func _iter_init(iter): iter[0] = _from return iter[0] < _to - + func _iter_next(iter): iter[0] += 1 return iter[0] < _to - + func _iter_get(iter): return iter - + func _ready(): var my_range = MyRange.new(2, 5) for x in my_range: @@ -611,6 +621,8 @@ enum **ConnectFlags**: :ref:`🔗` \ **注意：**\ 基类 **Object** 定义了一些通知（\ :ref:`NOTIFICATION_POSTINITIALIZE` 和 :ref:`NOTIFICATION_PREDELETE`\ ）。\ :ref:`Node` 等继承类定义了更多通知，这些通知也由该方法接收。 +\ **注意：**\ 与其他虚方法不同，该方法会被每个覆盖的脚本自动调用。这意味着不应该通过 GDScript 中的 ``super`` 或其他语言中的类似手段来调用基础实现。 + .. rst-class:: classref-item-separator ---- @@ -651,7 +663,9 @@ enum **ConnectFlags**: :ref:`🔗` 覆盖该方法以自定义 :ref:`set()` 的行为。应将 ``property`` 设置为 ``value`` 并返回 ``true``\ ，如果 ``property`` 正常处理则返回 ``false``\ 。设置 ``property`` 的\ *确切*\ 方式取决于该方法的实现。 -结合 :ref:`_get()` 和 :ref:`_get_property_list()`\ ，该方法允许定义自定义属性，这对编辑器插件特别有用。注意属性\ *必须*\ 在 :ref:`get_property_list()` 中存在，否则该方法将不会被调用。 +结合 :ref:`_get()` 和 :ref:`_get_property_list()`\ ，该方法允许定义自定义属性，对编辑器插件特别有用。 + +\ **注意：**\ 设置对象的内置属性时不会调用该方法，包括使用 :ref:`@GDScript.@export` 定义的属性。 .. tabs:: @@ -659,14 +673,14 @@ enum **ConnectFlags**: :ref:`🔗` .. code-tab:: gdscript var internal_data = {} - + func _set(property, value): if property == "fake_property": # 在冒牌属性中存值。 internal_data["fake_property"] = value return true return false - + func _get_property_list(): return [ { "name": "fake_property", "type": TYPE_INT } @@ -675,7 +689,7 @@ enum **ConnectFlags**: :ref:`🔗` .. code-tab:: csharp private Godot.Collections.Dictionary _internalData = new Godot.Collections.Dictionary(); - + public override bool _Set(StringName property, Variant value) { if (property == "FakeProperty") @@ -684,10 +698,10 @@ enum **ConnectFlags**: :ref:`🔗` _internalData["FakeProperty"] = value; return true; } - + return false; } - + public override Godot.Collections.Array _GetPropertyList() { return @@ -718,7 +732,7 @@ enum **ConnectFlags**: :ref:`🔗` func _to_string(): return "欢迎来到 Godot 4！" - + func _init(): print(self) # 输出“欢迎来到 Godot 4！” var a = str(self) # a 是“欢迎来到 Godot 4！” @@ -742,13 +756,13 @@ enum **ConnectFlags**: :ref:`🔗` @tool extends Node - + @export var is_number_editable: bool: set(value): is_number_editable = value notify_property_list_changed() @export var number: int - + func _validate_property(property: Dictionary): if property.name == "number" and not is_number_editable: property.usage |= PROPERTY_USAGE_READ_ONLY @@ -759,7 +773,7 @@ enum **ConnectFlags**: :ref:`🔗` public partial class MyNode : Node { private bool _isNumberEditable; - + [Export] public bool IsNumberEditable { @@ -770,10 +784,10 @@ enum **ConnectFlags**: :ref:`🔗` NotifyPropertyListChanged(); } } - + [Export] public int Number { get; set; } - + public override void _ValidateProperty(Godot.Collections.Dictionary property) { if (property["name"].AsStringName() == PropertyName.Number && !IsNumberEditable) @@ -964,157 +978,15 @@ enum **ConnectFlags**: :ref:`🔗` :ref:`Error` **connect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) :ref:`🔗` -按名称将 ``signal`` 连接到 ``callable``\ 。还可以添加可选的 ``flags`` 来配置该连接的行为（请参阅 :ref:`ConnectFlags` 常量）。 +将名为 ``signal`` 的信号与可调用体 ``callable`` 连接。还可以通过 ``flags`` 添加标志，配置连接行为（见 :ref:`ConnectFlags` 常量）。 -一个信号只能连接到同一个 :ref:`Callable` 一次。如果该信号已经连接，除非该信号是使用 :ref:`CONNECT_REFERENCE_COUNTED` 连接的，否则该方法会返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER` 并推送一条错误消息。为防止这种情况，请首先使用 :ref:`is_connected()` 检查已存在的连接。 +一个信号与同一个 :ref:`Callable` 只能连接一次。如果信号已连接，则该方法会返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER` 并报错误，除非信号是使用 :ref:`CONNECT_REFERENCE_COUNTED` 连接的。要防止出现这种情况，请先使用 :ref:`is_connected()` 检查是否已存在连接。 -如果 ``callable`` 的对象被释放，则该连接将会丢失。 - -\ **推荐语法的示例：**\ - -连接信号是 Godot 中最常见的操作之一，API 提供了许多这样做的选项，这些选项将在下面进一步介绍。下面的代码块显示了推荐的方法。 - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - var button = Button.new() - # 这里的 `button_down` 是一个 Signal 变体类型，因此我们调用 Signal.connect() 方法，而不是 Object.connect()。 - # 请参阅下面的讨论以更深入地了解该 API。 - button.button_down.connect(_on_button_down) - - # 这假设存在一个“Player”类，它定义了一个“hit”信号。 - var player = Player.new() - # 我们再次使用 Signal.connect() ，并且我们还使用了 Callable.bind() 方法， - # 它返回一个带有参数绑定的新 Callable。 - player.hit.connect(_on_player_hit.bind("剑", 100)) - - func _on_button_down(): - print("按钮按下！") - - func _on_player_hit(weapon_type, damage): - print("用武器 %s 击中，造成 %d 伤害。" % [weapon_type, damage]) - - .. code-tab:: csharp - - public override void _Ready() - { - var button = new Button(); - // C# 支持将信号作为事件传递，因此我们可以使用这个惯用的构造： - button.ButtonDown += OnButtonDown; - - // 这假设存在一个“Player”类，它定义了一个“Hit”信号。 - var player = new Player(); - // 当我们需要绑定额外的参数时，我们可以使用 Lambda 表达式。 - player.Hit += () => OnPlayerHit("剑", 100); - } - - private void OnButtonDown() - { - GD.Print("按钮按下！"); - } - - private void OnPlayerHit(string weaponType, int damage) - { - GD.Print($"用武器 {weaponType} 击中，造成 {damage} 伤害。"); - } - - - -\ **\ ``Object.connect()`` 还是 ``Signal.connect()``\ ？**\ - -如上所示，推荐的连接信号的方法不是 :ref:`connect()`\ 。下面的代码块显示了连接信号的四个选项，使用该传统方法或推荐的 :ref:`Signal.connect()`\ ，并使用一个隐式的 :ref:`Callable` 或手动定义的 :ref:`Callable`\ 。 - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - var button = Button.new() - # 选项 1：Object.connect() 并使用已定义的函数的隐式 Callable。 - button.connect("button_down", _on_button_down) - # 选项 2：Object.connect() 并使用由目标对象和方法名称构造的 Callable。 - button.connect("button_down", Callable(self, "_on_button_down")) - # 选项 3：Signal.connect() 并使用已定义的函数的隐式 Callable。 - button.button_down.connect(_on_button_down) - # 选项 4：Signal.connect() 并使用由目标对象和方法名称构造的 Callable。 - button.button_down.connect(Callable(self, "_on_button_down")) - - func _on_button_down(): - print("按钮按下！") - - .. code-tab:: csharp - - public override void _Ready() - { - var button = new Button(); - // 选项 1：在 C# 中，我们可以将信号用作事件并使用以下惯用语法进行连接： - button.ButtonDown += OnButtonDown; - // 选项 2：GodotObject.Connect() 并使用从方法组构造的 Callable。 - button.Connect(Button.SignalName.ButtonDown, Callable.From(OnButtonDown)); - // 选项 3：GodotObject.Connect() 并使用由目标对象和方法名称构造的 Callable。 - button.Connect(Button.SignalName.ButtonDown, new Callable(this, MethodName.OnButtonDown)); - } - - private void OnButtonDown() - { - GD.Print("按钮按下！"); - } - - - -虽然所有选项都有相同的结果（\ ``button`` 的 :ref:`BaseButton.button_down` 信号将被连接到 ``_on_button_down``\ ），但\ **选项 3** 提供了最好的验证：如果 ``button_down`` :ref:`Signal` 或 ``_on_button_down`` :ref:`Callable` 没有被定义，它将打印一个编译时错误。另一方面，\ **选项 2** 只依赖于字符串名称，并且只能在运行时验证这两个名称：如果 ``"button_down"`` 不对应于一个信号，或者如果 ``"_on_button_down"`` 不是对象 ``self`` 中的注册方法，它将打印一个运行时错误。使用选项 1、2、4 的主要原因是你确实需要使用字符串（例如，根据从配置文件读取的字符串，以编程的方式连接信号）。否则推荐选项 3（也是最快的）。 - -\ **绑定和传递参数：**\ - -绑定参数的语法是通过 :ref:`Callable.bind()`\ ，它返回一个绑定了参数的 :ref:`Callable` 的副本。 - -当调用 :ref:`emit_signal()` 或 :ref:`Signal.emit()` 时，信号参数也可以被传递。下面的示例显示了这些信号参数和绑定参数之间的关系。 - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - # 这假设存在一个 `Player` 类，它定义了一个 `hit` 信号。 - var player = Player.new() - # 使用 Callable.bind()。 - player.hit.connect(_on_player_hit.bind("剑", 100)) - - # 发出信号时添加的参数首先被传递。 - player.hit.emit("黑暗领主", 5) - - # 我们在发出时传递两个参数（`hit_by`，`level`）， - # 并在连接时再绑定两个参数（`weapon_type`、`damage`）。 - func _on_player_hit(hit_by, level, weapon_type, damage): - print("被 %s（等级 %d）用武器 %s 击中，造成 %d 伤害。" % [hit_by, level, weapon_type, damage]) - - .. code-tab:: csharp - - public override void _Ready() - { - // 这假设存在一个 `Player` 类，它定义了一个 `Hit` 信号。 - var player = new Player(); - // 使用 lambda 表达式创建一个闭包来捕获额外的参数。 - // lambda 仅接收由信号委托定义的参数。 - player.Hit += (hitBy, level) => OnPlayerHit(hitBy, level, "剑", 100); - - // 发出信号时添加的参数首先被传递。 - player.EmitSignal(SignalName.Hit, "黑暗领主", 5); - } - - // 我们在发出时传递两个参数（`hit_by`，`level`）， - // 并在连接时再绑定两个参数（`weapon_type`、`damage`）。 - private void OnPlayerHit(string hitBy, int level, string weaponType, int damage) - { - GD.Print($"被 {hitBy}（等级 {level}）用武器 {weaponType} 击中，造成 {damage} 伤害。"); - } +\ **注意：**\ 如果 ``callable`` 的对象被释放，连接就会丢失。 +\ **注意：**\ 在 GDScript 中，通常建议使用 :ref:`Signal.connect()` 来连接信号。 +\ **注意：**\ 该操作（和其他所有与信号相关的操作）是线程安全的。 .. rst-class:: classref-item-separator @@ -1169,7 +1041,7 @@ enum **ConnectFlags**: :ref:`🔗` |void| **free**\ (\ ) :ref:`🔗` -从内存中删除该对象。对该对象的预先存在的引用会变得无效，并且任何访问它们的尝试都将会产生一个运行时错误。使用 :ref:`@GlobalScope.is_instance_valid()` 检查引用时将返回 ``false``\ 。 +从内存中删除该对象。此前存在的对该对象的引用会失效，尝试访问这些引用会产生运行时错误。使用 :ref:`@GlobalScope.is_instance_valid()` 检查引用时将返回 ``false``\ 。等价于 GDExtension C++ 中的 ``memdelete`` 函数。 .. rst-class:: classref-item-separator @@ -1597,10 +1469,10 @@ enum **ConnectFlags**: :ref:`🔗` var player = Node2D.new() player.set_script(load("res://player.gd")) - + player.notification(NOTIFICATION_ENTER_TREE) # 调用顺序是 Object -> Node -> Node2D -> player.gd。 - + player.notification(NOTIFICATION_ENTER_TREE, true) # 调用顺序是 player.gd -> Node2D -> Node -> Object。 @@ -1608,10 +1480,10 @@ enum **ConnectFlags**: :ref:`🔗` var player = new Node2D(); player.SetScript(GD.Load("res://player.gd")); - + player.Notification(NotificationEnterTree); // 调用顺序是 GodotObject -> Node -> Node2D -> player.gd。 - + player.Notification(NotificationEnterTree, true); // 调用顺序是 player.gd -> Node2D -> Node -> GodotObject。 @@ -1747,11 +1619,11 @@ enum **ConnectFlags**: :ref:`🔗` var node = Node2D.new() add_child(node) - + node.rotation = 1.5 node.set_deferred("rotation", 3.0) print(node.rotation) # 输出 1.5 - + await get_tree().process_frame print(node.rotation) # 输出 3.0 @@ -1761,7 +1633,7 @@ enum **ConnectFlags**: :ref:`🔗` node.Rotation = 1.5f; node.SetDeferred(Node2D.PropertyName.Rotation, 3f); GD.Print(node.Rotation); // 输出 1.5 - + await ToSignal(GetTree(), SceneTree.SignalName.ProcessFrame); GD.Print(node.Rotation); // 输出 3.0 @@ -1911,6 +1783,7 @@ enum **ConnectFlags**: :ref:`🔗` \ **注意：**\ 如果没有 **Object** 实例，则无法使用该方法，因为它需要 :ref:`can_translate_messages()` 方法。要在静态上下文中翻译字符串，请使用 :ref:`TranslationServer.translate_plural()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_occluder3d.rst b/classes/zh_CN/class_occluder3d.rst index 67d041b3db..4450dc6cdb 100644 --- a/classes/zh_CN/class_occluder3d.rst +++ b/classes/zh_CN/class_occluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Occluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Occluder3D.xml. .. _class_Occluder3D: @@ -76,6 +76,7 @@ Occluder3D 返回该遮挡器形状的顶点位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_occluderinstance3d.rst b/classes/zh_CN/class_occluderinstance3d.rst index 9a22061452..edb4adb1c9 100644 --- a/classes/zh_CN/class_occluderinstance3d.rst +++ b/classes/zh_CN/class_occluderinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OccluderInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OccluderInstance3D.xml. .. _class_OccluderInstance3D: @@ -166,6 +166,7 @@ OccluderInstance3D 基于 ``value``\ ，启用或禁用 :ref:`bake_mask` 中的指定层，该层由给定的一个介于 1 和 32 之间的 ``layer_number`` 指定。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_occluderpolygon2d.rst b/classes/zh_CN/class_occluderpolygon2d.rst index e2e699cc08..6c55c1770b 100644 --- a/classes/zh_CN/class_occluderpolygon2d.rst +++ b/classes/zh_CN/class_occluderpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OccluderPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OccluderPolygon2D.xml. .. _class_OccluderPolygon2D: @@ -135,6 +135,7 @@ enum **CullMode**: :ref:`🔗` **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_offlinemultiplayerpeer.rst b/classes/zh_CN/class_offlinemultiplayerpeer.rst index acd5257140..595599fe86 100644 --- a/classes/zh_CN/class_offlinemultiplayerpeer.rst +++ b/classes/zh_CN/class_offlinemultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/multiplayer/doc_classes/OfflineMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/OfflineMultiplayerPeer.xml. .. _class_OfflineMultiplayerPeer: @@ -24,6 +24,7 @@ OfflineMultiplayerPeer 这意味着 :ref:`SceneTree` 会默认作为多人游戏控制方。调用 :ref:`MultiplayerAPI.is_server()` 会返回 ``true``\ ，调用 :ref:`MultiplayerAPI.get_unique_id()` 会返回 :ref:`MultiplayerPeer.TARGET_PEER_SERVER`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_oggpacketsequence.rst b/classes/zh_CN/class_oggpacketsequence.rst index 86090dad9b..ccc9852cfb 100644 --- a/classes/zh_CN/class_oggpacketsequence.rst +++ b/classes/zh_CN/class_oggpacketsequence.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/ogg/doc_classes/OggPacketSequence.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/ogg/doc_classes/OggPacketSequence.xml. .. _class_OggPacketSequence: @@ -125,6 +125,7 @@ Ogg 数据包序列。 该流的长度，以秒为单位。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_oggpacketsequenceplayback.rst b/classes/zh_CN/class_oggpacketsequenceplayback.rst index 3c5ff9a7f2..3b90a4b624 100644 --- a/classes/zh_CN/class_oggpacketsequenceplayback.rst +++ b/classes/zh_CN/class_oggpacketsequenceplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/ogg/doc_classes/OggPacketSequencePlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/ogg/doc_classes/OggPacketSequencePlayback.xml. .. _class_OggPacketSequencePlayback: @@ -17,6 +17,7 @@ OggPacketSequencePlayback 该类目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_omnilight3d.rst b/classes/zh_CN/class_omnilight3d.rst index 65a9938a1b..b41b2931ac 100644 --- a/classes/zh_CN/class_omnilight3d.rst +++ b/classes/zh_CN/class_omnilight3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OmniLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OmniLight3D.xml. .. _class_OmniLight3D: @@ -150,9 +150,12 @@ enum **ShadowMode**: :ref:`🔗` - |void| **set_shadow_mode**\ (\ value\: :ref:`ShadowMode`\ ) - :ref:`ShadowMode` **get_shadow_mode**\ (\ ) -见 :ref:`ShadowMode`\ 。 +.. container:: contribute + + 该属性目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxraction.rst b/classes/zh_CN/class_openxraction.rst index f0907695ce..26b65ac5c0 100644 --- a/classes/zh_CN/class_openxraction.rst +++ b/classes/zh_CN/class_openxraction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRAction.xml. .. _class_OpenXRAction: @@ -153,6 +153,7 @@ enum **ActionType**: :ref:`🔗` **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxractionbindingmodifier.rst b/classes/zh_CN/class_openxractionbindingmodifier.rst index eb5b03e6eb..2f7188dfab 100644 --- a/classes/zh_CN/class_openxractionbindingmodifier.rst +++ b/classes/zh_CN/class_openxractionbindingmodifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRActionBindingModifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRActionBindingModifier.xml. .. _class_OpenXRActionBindingModifier: @@ -24,6 +24,7 @@ OpenXRActionBindingModifier 对交互配置相关的独立动作应用的绑定修改器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxractionmap.rst b/classes/zh_CN/class_openxractionmap.rst index 96a14052d9..a1a72df975 100644 --- a/classes/zh_CN/class_openxractionmap.rst +++ b/classes/zh_CN/class_openxractionmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRActionMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRActionMap.xml. .. _class_OpenXRActionMap: @@ -248,6 +248,7 @@ OpenXR 使用类似于 Godots 输入映射系统的动作系统，将各种类 移除交互配置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxractionset.rst b/classes/zh_CN/class_openxractionset.rst index 6d2f08a361..1da357f8b7 100644 --- a/classes/zh_CN/class_openxractionset.rst +++ b/classes/zh_CN/class_openxractionset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRActionSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRActionSet.xml. .. _class_OpenXRActionSet: @@ -153,6 +153,7 @@ OpenXR 中的动作集定义了一组可以统一激活的动作。这允许游 从该动作集中移除某个动作。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxranalogthresholdmodifier.rst b/classes/zh_CN/class_openxranalogthresholdmodifier.rst index 39f23782ee..a3daa87575 100644 --- a/classes/zh_CN/class_openxranalogthresholdmodifier.rst +++ b/classes/zh_CN/class_openxranalogthresholdmodifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRAnalogThresholdModifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRAnalogThresholdModifier.xml. .. _class_OpenXRAnalogThresholdModifier: @@ -78,7 +78,7 @@ OpenXRAnalogThresholdModifier - |void| **set_off_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_off_threshold**\ (\ ) -输入值低于此值时，输出变为 false。 +输入值低于此值时，输出变为 ``false``\ 。 .. rst-class:: classref-item-separator @@ -112,9 +112,10 @@ OpenXRAnalogThresholdModifier - |void| **set_on_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_on_threshold**\ (\ ) -输入大于等于此值时，输出变为 true。直到低于 :ref:`off_threshold` 都会保持为 true。 +输入大于等于此值时，输出变为 ``true``\ 。直到低于 :ref:`off_threshold` 都会保持为 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrapiextension.rst b/classes/zh_CN/class_openxrapiextension.rst index be772ad00c..aee541882d 100644 --- a/classes/zh_CN/class_openxrapiextension.rst +++ b/classes/zh_CN/class_openxrapiextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRAPIExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRAPIExtension.xml. .. _class_OpenXRAPIExtension: @@ -111,9 +111,13 @@ OpenXRAPIExtension +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`openxr_swapchain_release`\ (\ swapchain\: :ref:`int`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`register_frame_info_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_play_space`\ (\ space\: ``const void*``\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_emulate_environment_blend_mode_alpha_blend`\ (\ enabled\: :ref:`bool`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -129,9 +133,11 @@ OpenXRAPIExtension +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform_from_pose`\ (\ pose\: ``const void*``\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`unregister_frame_info_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr_result`\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -414,7 +420,7 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗` **get_system_id**\ (\ ) :ref:`🔗` -返回系统的 id，它是一个被转换为整数的 `XrSystemId `__\ 。 +返回系统的 ID，是一个被转换为整数的 `XrSystemId `__\ 。 .. rst-class:: classref-item-separator @@ -556,7 +562,7 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗`\ ) :ref:`🔗` +|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` 将给定扩展注册为组合层提供器。 @@ -564,11 +570,23 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗`\ ) :ref:`🔗` + +将给定扩展注册为会通过 :ref:`OpenXRExtensionWrapper._set_frame_wait_info_and_get_next_pointer()`\ 、\ :ref:`OpenXRExtensionWrapper._set_view_locate_info_and_get_next_pointer()`\ 、\ :ref:`OpenXRExtensionWrapper._set_frame_end_info_and_get_next_pointer()` 等虚方法修改帧信息。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_register_projection_views_extension: .. rst-class:: classref-method -|void| **register_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` +|void| **register_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` 将给定的扩展注册为投影视图的附加数据结构提供器。 @@ -576,6 +594,18 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗` + +将 OpenXR 所使用的参考空间设置为给定的 `XrSpace `__\ （转换为 ``void *``\ ）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_set_emulate_environment_blend_mode_alpha_blend: .. rst-class:: classref-method @@ -664,7 +694,7 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗`\ ) :ref:`🔗` +|void| **unregister_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` 将给定的扩展取消注册为合成层提供器。 @@ -672,11 +702,23 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗`\ ) :ref:`🔗` + +将给定的扩展取消注册为修改帧信息。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_unregister_projection_views_extension: .. rst-class:: classref-method -|void| **unregister_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` +|void| **unregister_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` 将给定的扩展取消注册为投影视图的附加数据结构提供器。 @@ -693,6 +735,7 @@ enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗`__\ （转换为整数）是成功的，则返回 ``true``\ 。否则返回 ``false`` 并打印被转换为字符串的 `XrResult `__ ，以及指定的附加信息。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrbindingmodifier.rst b/classes/zh_CN/class_openxrbindingmodifier.rst index 22c5542b9f..ceb6870546 100644 --- a/classes/zh_CN/class_openxrbindingmodifier.rst +++ b/classes/zh_CN/class_openxrbindingmodifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRBindingModifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRBindingModifier.xml. .. _class_OpenXRBindingModifier: @@ -31,11 +31,11 @@ OpenXRBindingModifier .. table:: :widths: auto - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_description`\ (\ ) |virtual| |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`_get_ip_modification`\ (\ ) |virtual| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_description`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_get_ip_modification`\ (\ ) |virtual| |required| | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ OpenXRBindingModifier .. rst-class:: classref-method -:ref:`String` **_get_description**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_description**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回该类的描述，会显示在绑定修改器编辑器的标题栏。 @@ -62,13 +62,14 @@ OpenXRBindingModifier .. rst-class:: classref-method -:ref:`PackedByteArray` **_get_ip_modification**\ (\ ) |virtual| :ref:`🔗` +:ref:`PackedByteArray` **_get_ip_modification**\ (\ ) |virtual| |required| :ref:`🔗` 返回在提交该修改器所涉及的交互绑定时发送给 OpenXR 的数据。 \ **注意：**\ 这必须是与 ``XrBindingModificationBaseHeaderKHR`` 结构兼容的数据。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrbindingmodifiereditor.rst b/classes/zh_CN/class_openxrbindingmodifiereditor.rst index 4f4aea4fe4..f773423802 100644 --- a/classes/zh_CN/class_openxrbindingmodifiereditor.rst +++ b/classes/zh_CN/class_openxrbindingmodifiereditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRBindingModifierEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRBindingModifierEditor.xml. .. _class_OpenXRBindingModifierEditor: @@ -94,6 +94,7 @@ OpenXR 动作映射所使用的默认绑定修改器编辑器。 针对给定的 ``action_map`` 和 ``binding_modifier`` 设置该编辑器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrcompositionlayer.rst b/classes/zh_CN/class_openxrcompositionlayer.rst index 655320ffbd..8cb109433f 100644 --- a/classes/zh_CN/class_openxrcompositionlayer.rst +++ b/classes/zh_CN/class_openxrcompositionlayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRCompositionLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayer.xml. .. _class_OpenXRCompositionLayer: @@ -35,19 +35,41 @@ OpenXRCompositionLayer .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`alpha_blend` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`Vector2i` | :ref:`android_surface_size` | ``Vector2i(1024, 1024)`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`SubViewport` | :ref:`layer_viewport` | | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sort_order` | ``1`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`use_android_surface` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`alpha_blend` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Vector2i` | :ref:`android_surface_size` | ``Vector2i(1024, 1024)`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`SubViewport` | :ref:`layer_viewport` | | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sort_order` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_alpha_swizzle` | ``3`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_blue_swizzle` | ``2`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Color` | :ref:`swapchain_state_border_color` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_green_swizzle` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Wrap` | :ref:`swapchain_state_horizontal_wrap` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Filter` | :ref:`swapchain_state_mag_filter` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`swapchain_state_max_anisotropy` | ``1.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Filter` | :ref:`swapchain_state_min_filter` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`MipmapMode` | :ref:`swapchain_state_mipmap_mode` | ``2`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_red_swizzle` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Wrap` | :ref:`swapchain_state_vertical_wrap` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`use_android_surface` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group @@ -71,6 +93,191 @@ OpenXRCompositionLayer .. rst-class:: classref-descriptions-group +枚举 +---- + +.. _enum_OpenXRCompositionLayer_Filter: + +.. rst-class:: classref-enumeration + +enum **Filter**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_FILTER_NEAREST: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_NEAREST** = ``0`` + +对纹理进行采样时执行最邻近过滤。 + +.. _class_OpenXRCompositionLayer_constant_FILTER_LINEAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_LINEAR** = ``1`` + +对纹理进行采样时执行线性过滤。 + +.. _class_OpenXRCompositionLayer_constant_FILTER_CUBIC: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_CUBIC** = ``2`` + +对纹理进行采样时执行立方过滤。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_MipmapMode: + +.. rst-class:: classref-enumeration + +enum **MipmapMode**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_DISABLED** = ``0`` + +禁用 Mipmap。 + +\ **注意：**\ Mipmap 只有在兼容渲染器中能够禁用。 + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_NEAREST: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_NEAREST** = ``1`` + +使用最接近分辨率的 mipmap。 + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_LINEAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_LINEAR** = ``2`` + +使用最接近分辨率的两个 mipmap 的线性插值。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_Wrap: + +.. rst-class:: classref-enumeration + +enum **Wrap**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_BORDER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_CLAMP_TO_BORDER** = ``0`` + +使用指定的边框颜色限制纹理。 + +.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_CLAMP_TO_EDGE** = ``1`` + +使用边缘颜色限制纹理。 + +.. _class_OpenXRCompositionLayer_constant_WRAP_REPEAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_REPEAT** = ``2`` + +无限重复纹理。 + +.. _class_OpenXRCompositionLayer_constant_WRAP_MIRRORED_REPEAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_MIRRORED_REPEAT** = ``3`` + +无限重复纹理，每次重复都进行镜像。 + +.. _class_OpenXRCompositionLayer_constant_WRAP_MIRROR_CLAMP_TO_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_MIRROR_CLAMP_TO_EDGE** = ``4`` + +纹理会进行一次镜像，然后使用边缘颜色进行限制。 + +\ **注意：**\ 该环绕模式在兼容渲染器中不可用。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_Swizzle: + +.. rst-class:: classref-enumeration + +enum **Swizzle**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_RED: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_RED** = ``0`` + +将颜色通道映射为红色通道的值。 + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_GREEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_GREEN** = ``1`` + +将颜色通道映射为绿色通道的值。 + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_BLUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_BLUE** = ``2`` + +将颜色通道映射为蓝色通道的值。 + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ALPHA: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ALPHA** = ``3`` + +将颜色通道映射为 Alpha 通道的值。 + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ZERO: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ZERO** = ``4`` + +将颜色通道映射为零。 + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ONE** = ``5`` + +将颜色通道映射为一。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 属性说明 -------- @@ -165,6 +372,215 @@ OpenXRCompositionLayer ---- +.. _class_OpenXRCompositionLayer_property_swapchain_state_alpha_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_alpha_swizzle** = ``3`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_alpha_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_alpha_swizzle**\ (\ ) + +交换链状态的 Alpha 通道分量重排值。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_blue_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_blue_swizzle** = ``2`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_blue_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_blue_swizzle**\ (\ ) + +交换链状态的蓝色通道分量重排值。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_border_color: + +.. rst-class:: classref-property + +:ref:`Color` **swapchain_state_border_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_border_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_border_color**\ (\ ) + +当环绕模式为限制到边界时，使用的交换链状态的边框颜色。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_green_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_green_swizzle** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_green_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_green_swizzle**\ (\ ) + +交换链状态的绿色通道分量重排值。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_horizontal_wrap: + +.. rst-class:: classref-property + +:ref:`Wrap` **swapchain_state_horizontal_wrap** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_horizontal_wrap**\ (\ value\: :ref:`Wrap`\ ) +- :ref:`Wrap` **get_horizontal_wrap**\ (\ ) + +交换链状态的水平环绕模式。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_mag_filter: + +.. rst-class:: classref-property + +:ref:`Filter` **swapchain_state_mag_filter** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mag_filter**\ (\ value\: :ref:`Filter`\ ) +- :ref:`Filter` **get_mag_filter**\ (\ ) + +交换链状态的放大过滤器。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_max_anisotropy: + +.. rst-class:: classref-property + +:ref:`float` **swapchain_state_max_anisotropy** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_max_anisotropy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_anisotropy**\ (\ ) + +交换链状态的最大各向异性。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_min_filter: + +.. rst-class:: classref-property + +:ref:`Filter` **swapchain_state_min_filter** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_min_filter**\ (\ value\: :ref:`Filter`\ ) +- :ref:`Filter` **get_min_filter**\ (\ ) + +交换链状态的缩小过滤器。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_mipmap_mode: + +.. rst-class:: classref-property + +:ref:`MipmapMode` **swapchain_state_mipmap_mode** = ``2`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mipmap_mode**\ (\ value\: :ref:`MipmapMode`\ ) +- :ref:`MipmapMode` **get_mipmap_mode**\ (\ ) + +交换链状态的 mipmap 模式。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_red_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_red_swizzle** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_red_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_red_swizzle**\ (\ ) + +交换链状态的红色通道分量重排值。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_vertical_wrap: + +.. rst-class:: classref-property + +:ref:`Wrap` **swapchain_state_vertical_wrap** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_vertical_wrap**\ (\ value\: :ref:`Wrap`\ ) +- :ref:`Wrap` **get_vertical_wrap**\ (\ ) + +交换链状态的垂直环绕模式。 + +\ **注意：**\ 该属性仅对支持 OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan 扩展的设备有效。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRCompositionLayer_property_use_android_surface: .. rst-class:: classref-property @@ -230,6 +646,7 @@ OpenXRCompositionLayer \ **注意：**\ 仅在 OpenXR 会话启动后才会返回准确结果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrcompositionlayercylinder.rst b/classes/zh_CN/class_openxrcompositionlayercylinder.rst index 12c6c005cf..84f1bc4d9e 100644 --- a/classes/zh_CN/class_openxrcompositionlayercylinder.rst +++ b/classes/zh_CN/class_openxrcompositionlayercylinder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRCompositionLayerCylinder.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerCylinder.xml. .. _class_OpenXRCompositionLayerCylinder: @@ -31,15 +31,15 @@ OpenXR 合成层，允许在圆柱体的内部切片上渲染 :ref:`SubViewport< .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`aspect_ratio` | ``1.0`` | - +---------------------------+-------------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`central_angle` | ``1.5708`` | - +---------------------------+-------------------------------------------------------------------------------------------+------------+ - | :ref:`int` | :ref:`fallback_segments` | ``10`` | - +---------------------------+-------------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`radius` | ``1.0`` | - +---------------------------+-------------------------------------------------------------------------------------------+------------+ + +---------------------------+-------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`aspect_ratio` | ``1.0`` | + +---------------------------+-------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`central_angle` | ``1.5707964`` | + +---------------------------+-------------------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`fallback_segments` | ``10`` | + +---------------------------+-------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`radius` | ``1.0`` | + +---------------------------+-------------------------------------------------------------------------------------------+---------------+ .. rst-class:: classref-section-separator @@ -71,7 +71,7 @@ OpenXR 合成层，允许在圆柱体的内部切片上渲染 :ref:`SubViewport< .. rst-class:: classref-property -:ref:`float` **central_angle** = ``1.5708`` :ref:`🔗` +:ref:`float` **central_angle** = ``1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,6 +115,7 @@ OpenXR 合成层，允许在圆柱体的内部切片上渲染 :ref:`SubViewport< 圆柱体的半径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrcompositionlayerequirect.rst b/classes/zh_CN/class_openxrcompositionlayerequirect.rst index b8bdfd8a92..53c40cdb6a 100644 --- a/classes/zh_CN/class_openxrcompositionlayerequirect.rst +++ b/classes/zh_CN/class_openxrcompositionlayerequirect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRCompositionLayerEquirect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerEquirect.xml. .. _class_OpenXRCompositionLayerEquirect: @@ -31,17 +31,17 @@ OpenXRCompositionLayerEquirect .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`central_horizontal_angle` | ``1.5708`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ - | :ref:`int` | :ref:`fallback_segments` | ``10`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`lower_vertical_angle` | ``0.785398`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`radius` | ``1.0`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ - | :ref:`float` | :ref:`upper_vertical_angle` | ``0.785398`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`central_horizontal_angle` | ``1.5707964`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`fallback_segments` | ``10`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`lower_vertical_angle` | ``0.7853982`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`radius` | ``1.0`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`upper_vertical_angle` | ``0.7853982`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+---------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ OpenXRCompositionLayerEquirect .. rst-class:: classref-property -:ref:`float` **central_horizontal_angle** = ``1.5708`` :ref:`🔗` +:ref:`float` **central_horizontal_angle** = ``1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ OpenXRCompositionLayerEquirect .. rst-class:: classref-property -:ref:`float` **lower_vertical_angle** = ``0.785398`` :ref:`🔗` +:ref:`float` **lower_vertical_angle** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ OpenXRCompositionLayerEquirect .. rst-class:: classref-property -:ref:`float` **upper_vertical_angle** = ``0.785398`` :ref:`🔗` +:ref:`float` **upper_vertical_angle** = ``0.7853982`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,6 +134,7 @@ OpenXRCompositionLayerEquirect 球体的上垂直角度。（与 :ref:`lower_vertical_angle` 一起）用于设置高度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrcompositionlayerquad.rst b/classes/zh_CN/class_openxrcompositionlayerquad.rst index 4ed815fd73..2e39e547a6 100644 --- a/classes/zh_CN/class_openxrcompositionlayerquad.rst +++ b/classes/zh_CN/class_openxrcompositionlayerquad.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRCompositionLayerQuad.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerQuad.xml. .. _class_OpenXRCompositionLayerQuad: @@ -58,6 +58,7 @@ OpenXRCompositionLayerQuad 四边形的尺寸。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrdpadbindingmodifier.rst b/classes/zh_CN/class_openxrdpadbindingmodifier.rst index b0e35629e6..25cc9de3b8 100644 --- a/classes/zh_CN/class_openxrdpadbindingmodifier.rst +++ b/classes/zh_CN/class_openxrdpadbindingmodifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRDpadBindingModifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRDpadBindingModifier.xml. .. _class_OpenXRDpadBindingModifier: @@ -33,25 +33,25 @@ OpenXRDpadBindingModifier .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`OpenXRActionSet` | :ref:`action_set` | | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`center_region` | ``0.1`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`String` | :ref:`input_path` | ``""`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`is_sticky` | ``false`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`OpenXRHapticBase` | :ref:`off_haptic` | | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`OpenXRHapticBase` | :ref:`on_haptic` | | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`threshold` | ``0.6`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`threshold_released` | ``0.4`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`wedge_angle` | ``1.5708`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------+------------+ + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`OpenXRActionSet` | :ref:`action_set` | | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`center_region` | ``0.1`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`String` | :ref:`input_path` | ``""`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`is_sticky` | ``false`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`OpenXRHapticBase` | :ref:`off_haptic` | | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`OpenXRHapticBase` | :ref:`on_haptic` | | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`threshold` | ``0.6`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`threshold_released` | ``0.4`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`wedge_angle` | ``1.5707964`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+ .. rst-class:: classref-section-separator @@ -124,9 +124,9 @@ OpenXRDpadBindingModifier - |void| **set_is_sticky**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_sticky**\ (\ ) -如果为 ``false``\ ，则摇杆进入新的十字键区域时变为 true。 +如果为 ``false``\ ，则摇杆进入新的十字键区域时变为 ``true``\ 。 -如果为 ``true``\ ，则摇杆保留在活动的十字键区域中时，即使与另一个区域重叠也仍然为 true。 +如果为 ``true``\ ，则摇杆保留在活动的十字键区域中时，即使与另一个区域重叠也仍然为 ``true``\ 。 .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ OpenXRDpadBindingModifier - |void| **set_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_threshold**\ (\ ) -输入值等于或大于该值时，十字键在该方向上变为 true。它会保持为 true，直到输入值低于 :ref:`threshold_released`\ 。 +输入值等于或大于该值时，十字键在该方向上变为 ``true``\ 。它会保持为 ``true``\ ，直到输入值低于 :ref:`threshold_released`\ 。 .. rst-class:: classref-item-separator @@ -194,7 +194,7 @@ OpenXRDpadBindingModifier - |void| **set_threshold_released**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_threshold_released**\ (\ ) -输入值低于此值时，输出变为 false。 +输入值低于此值时，输出变为 ``false``\ 。 .. rst-class:: classref-item-separator @@ -204,7 +204,7 @@ OpenXRDpadBindingModifier .. rst-class:: classref-property -:ref:`float` **wedge_angle** = ``1.5708`` :ref:`🔗` +:ref:`float` **wedge_angle** = ``1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,6 +214,7 @@ OpenXRDpadBindingModifier 每个楔形的角度，用于标识模拟十字键的四个方向。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrextensionwrapper.rst b/classes/zh_CN/class_openxrextensionwrapper.rst new file mode 100644 index 0000000000..11c95a01e6 --- /dev/null +++ b/classes/zh_CN/class_openxrextensionwrapper.rst @@ -0,0 +1,679 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRExtensionWrapper.xml. + +.. _class_OpenXRExtensionWrapper: + +OpenXRExtensionWrapper +====================== + +**继承：** :ref:`Object` + +**派生：** :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRFutureExtension`, :ref:`OpenXRRenderModelExtension` + +允许使用 GDExtension 实现 OpenXR 扩展。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +:ref:`OpenXRExtensionWrapperExtension` 允许使用 GDExtension 实现 OpenXR 扩展。扩展应该使用 :ref:`register_extension_wrapper()` 注册。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer`\ (\ index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_count`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_viewport_composition_layer_extension_properties`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_viewport_composition_layer_extension_property_defaults`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_before_instance_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_on_event_polled`\ (\ event\: ``const void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_created`\ (\ instance\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_post_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_pre_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_process`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_register_metadata`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_created`\ (\ session\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_destroyed`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_exiting`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_focused`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_idle`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_loss_pending`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_ready`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_stopping`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_synchronized`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_visible`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_sync_actions`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_viewport_composition_layer_destroyed`\ (\ layer\: ``const void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_android_surface_swapchain_create_info_and_get_next_pointer`\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_frame_end_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_frame_wait_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_hand_joint_locations_and_get_next_pointer`\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_projection_views_and_get_next_pointer`\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_reference_space_create_info_and_get_next_pointer`\ (\ reference_space_type\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_view_locate_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_viewport_composition_layer_and_get_next_pointer`\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_extension_wrapper`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` + +返回指向 ``XrCompositionLayerBaseHeader`` 结构的指针以提供给定的合成层。 + +仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时才会调用该函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer_count: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| :ref:`🔗` + +通过 :ref:`_get_composition_layer()` 返回该扩展包装器提供的合成层数量。 + +仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时，才会调用该方法。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer_order: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` + +返回一个整数，该整数将用于对通过 :ref:`_get_composition_layer()` 提供的给定合成层进行排序。数字越小，层就越容易移到列表的最前面，数字越大，层就越容易移到列表的最后面。默认投影层的顺序为 ``0``\ ，因此该方法提供的层可能应该位于（但不完全位于）\ ``0`` 的上方或下方。 + +仅当扩展程序先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时，才会调用该方法。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_requested_extensions: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| :ref:`🔗` + +返回与该扩展相关的 OpenXR 扩展的 :ref:`Dictionary`\ 。该 :ref:`Dictionary` 应包含扩展名，映射到 ``bool *`` 转换为整数： + +- 如果 ``bool *`` 是 ``nullptr``\ ，则该扩展是强制性的。 + +- 如果 ``bool *`` 指向布尔值，则在启用扩展的情况下，该布尔值将更新为 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_suggested_tracker_names: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| :ref:`🔗` + +返回扩展包装器中使用的位置跟踪器名称的 :ref:`PackedStringArray`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_viewport_composition_layer_extension_properties: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| :ref:`🔗` + +获取表示属性的 :ref:`Dictionary` 数组，就像 :ref:`Object._get_property_list()` 一样，将被添加到 :ref:`OpenXRCompositionLayer` 节点。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_viewport_composition_layer_extension_property_defaults: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| :ref:`🔗` + +获取一个 :ref:`Dictionary`\ ，其中包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性的默认值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_before_instance_created: + +.. rst-class:: classref-method + +|void| **_on_before_instance_created**\ (\ ) |virtual| :ref:`🔗` + +在创建 OpenXR 实例之前调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_event_polled: + +.. rst-class:: classref-method + +:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| :ref:`🔗` + +当有 OpenXR 事件需要处理时调用。实现时，如果事件已被处理，则返回 ``true``\ ，否则返回 ``false``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_instance_created: + +.. rst-class:: classref-method + +|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| :ref:`🔗` + +在创建 OpenXR 实例后立即调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_instance_destroyed: + +.. rst-class:: classref-method + +|void| **_on_instance_destroyed**\ (\ ) |virtual| :ref:`🔗` + +在 OpenXR 实例被销毁之前调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_main_swapchains_created: + +.. rst-class:: classref-method + +|void| **_on_main_swapchains_created**\ (\ ) |virtual| :ref:`🔗` + +在主交换链（重新）创建后立即调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_post_draw_viewport: + +.. rst-class:: classref-method + +|void| **_on_post_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` + +给定视口渲染后立即调用。 + +\ **注意：**\ 此时绘制命令可能还在队列中，尚未执行。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_pre_draw_viewport: + +.. rst-class:: classref-method + +|void| **_on_pre_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` + +给定视口渲染前立即调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_pre_render: + +.. rst-class:: classref-method + +|void| **_on_pre_render**\ (\ ) |virtual| :ref:`🔗` + +在 XR 视口开始其渲染步进之前调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_process: + +.. rst-class:: classref-method + +|void| **_on_process**\ (\ ) |virtual| :ref:`🔗` + +作为 OpenXR 进程处理的一部分调用。这发生在主循环的一般和物理处理步进之前。在该步进中，控制器数据被查询并可供游戏逻辑使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_register_metadata: + +.. rst-class:: classref-method + +|void| **_on_register_metadata**\ (\ ) |virtual| :ref:`🔗` + +允许扩展注册额外的控制器元数据。即使 OpenXR API 未被构造，也会调用该函数，因为元数据需要可供编辑器使用。 + +扩展还应该提供元数据，无论主机系统是否支持它们。控制器数据用于为可以访问相关硬件的用户设置动作映射。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_session_created: + +.. rst-class:: classref-method + +|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| :ref:`🔗` + +在创建 OpenXR 会话后立即调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_session_destroyed: + +.. rst-class:: classref-method + +|void| **_on_session_destroyed**\ (\ ) |virtual| :ref:`🔗` + +在 OpenXR 会话被销毁之前调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_exiting: + +.. rst-class:: classref-method + +|void| **_on_state_exiting**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为退出时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_focused: + +.. rst-class:: classref-method + +|void| **_on_state_focused**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为聚焦时调用。该状态是游戏运行时的活动状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_idle: + +.. rst-class:: classref-method + +|void| **_on_state_idle**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为空闲时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_loss_pending: + +.. rst-class:: classref-method + +|void| **_on_state_loss_pending**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为丢失挂起时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_ready: + +.. rst-class:: classref-method + +|void| **_on_state_ready**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为就绪时调用。这意味着 OpenXR 已准备好建立会话。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_stopping: + +.. rst-class:: classref-method + +|void| **_on_state_stopping**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为停止时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_synchronized: + +.. rst-class:: classref-method + +|void| **_on_state_synchronized**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为同步时调用。当应用程序失去焦点时，OpenXR 也会返回到该状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_visible: + +.. rst-class:: classref-method + +|void| **_on_state_visible**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 会话状态被更改为可见时调用。这意味着 OpenXR 现在已准备好接收帧。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_sync_actions: + +.. rst-class:: classref-method + +|void| **_on_sync_actions**\ (\ ) |virtual| :ref:`🔗` + +当 OpenXR 执行完动作同步时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_viewport_composition_layer_destroyed: + +.. rst-class:: classref-method + +|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| :ref:`🔗` + +当通过 :ref:`OpenXRCompositionLayer` 创建的合成层被销毁时调用。 + +\ ``layer`` 是指向 ``XrCompositionLayerBaseHeader`` 结构的指针。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_android_surface_swapchain_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_android_surface_swapchain_create_info_and_get_next_pointer**\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +向由 :ref:`OpenXRCompositionLayer` 创建的合成层添加其他数据结构。 + +\ ``property_values`` 包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_frame_end_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_frame_end_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +在 ``XrFrameEndInfo`` 中添加额外的数据结构。 + +仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_frame_info_extension()` 注册自身时才会调用该函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_frame_wait_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_frame_wait_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +在 ``XrFrameWaitInfo`` 中添加额外的数据结构。 + +仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_frame_info_extension()` 注册自身时才会调用该函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_hand_joint_locations_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +当每个手部跟踪器被创建时添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_instance_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +创建 OpenXR 实例时添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_projection_views_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_projection_views_and_get_next_pointer**\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +为 ``view_index`` 视图的投影视图添加的额外数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_reference_space_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_reference_space_create_info_and_get_next_pointer**\ (\ reference_space_type\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +在 ``XrReferenceSpaceCreateInfo`` 中添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_session_create_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +创建 OpenXR 会话时添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_swapchain_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +创建 OpenXR 交换链时添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_system_properties_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +查询 OpenXR 系统能力时添加额外的数据结构。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_view_locate_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_view_locate_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +为 ``XrViewLocateInfo`` 添加额外的数据结构。 + +仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_frame_info_extension()` 注册自身时才会调用该函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_viewport_composition_layer_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +向由 :ref:`OpenXRCompositionLayer` 创建的合成层添加其他数据结构。 + +\ ``property_values`` 包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性值。 + +\ ``layer`` 是指向 ``XrCompositionLayerBaseHeader`` 结构的指针。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_method_get_openxr_api: + +.. rst-class:: classref-method + +:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) :ref:`🔗` + +返回创建的 :ref:`OpenXRAPIExtension`\ ，可用于访问 OpenXR API。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_method_register_extension_wrapper: + +.. rst-class:: classref-method + +|void| **register_extension_wrapper**\ (\ ) :ref:`🔗` + +注册扩展程序。这应该发生在核心模块初始化级别。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrextensionwrapperextension.rst b/classes/zh_CN/class_openxrextensionwrapperextension.rst index 462b13d0ac..baeaeda82f 100644 --- a/classes/zh_CN/class_openxrextensionwrapperextension.rst +++ b/classes/zh_CN/class_openxrextensionwrapperextension.rst @@ -2,595 +2,29 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml. .. _class_OpenXRExtensionWrapperExtension: OpenXRExtensionWrapperExtension =============================== -**继承：** :ref:`Object` +**已弃用：** Use :ref:`OpenXRExtensionWrapper` instead. -允许客户端使用 GDExtension 实现 OpenXR 扩展。 +**继承：** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +允许使用 GDExtension 实现 OpenXR 扩展。 .. rst-class:: classref-introduction-group 描述 ---- -**OpenXRExtensionWrapperExtension** 允许客户端使用 GDExtension 实现 OpenXR 扩展。扩展应该使用 :ref:`register_extension_wrapper()` 注册。 - -.. rst-class:: classref-reftable-group - -方法 ----- - -.. table:: - :widths: auto - - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer`\ (\ index\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer_count`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_viewport_composition_layer_extension_properties`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_viewport_composition_layer_extension_property_defaults`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_before_instance_created`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_on_event_polled`\ (\ event\: ``const void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_instance_created`\ (\ instance\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_post_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_pre_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_process`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_register_metadata`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_session_created`\ (\ session\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_session_destroyed`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_exiting`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_focused`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_idle`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_loss_pending`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_ready`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_stopping`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_synchronized`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_visible`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_viewport_composition_layer_destroyed`\ (\ layer\: ``const void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_android_surface_swapchain_create_info_and_get_next_pointer`\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_hand_joint_locations_and_get_next_pointer`\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_projection_views_and_get_next_pointer`\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_viewport_composition_layer_and_get_next_pointer`\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api`\ (\ ) | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_extension_wrapper`\ (\ ) | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -方法说明 --------- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` - -返回指向 ``XrCompositionLayerBaseHeader`` 结构的指针以提供给定的合成层。 - -仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时才会调用该函数。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_count: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| :ref:`🔗` - -通过 :ref:`_get_composition_layer()` 返回该扩展包装器提供的合成层数量。 - -仅当扩展先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时，才会调用该方法。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_order: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` - -返回一个整数，该整数将用于对通过 :ref:`_get_composition_layer()` 提供的给定合成层进行排序。数字越小，层就越容易移到列表的最前面，数字越大，层就越容易移到列表的最后面。默认投影层的顺序为 ``0``\ ，因此该方法提供的层可能应该位于（但不完全位于）\ ``0`` 的上方或下方。 - -仅当扩展程序先前使用 :ref:`OpenXRAPIExtension.register_composition_layer_provider()` 注册自身时，才会调用该方法。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_requested_extensions: - -.. rst-class:: classref-method - -:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| :ref:`🔗` - -返回与该扩展相关的 OpenXR 扩展的 :ref:`Dictionary`\ 。该 :ref:`Dictionary` 应包含扩展名，映射到 ``bool *`` 转换为整数： - -- 如果 ``bool *`` 是 ``nullptr``\ ，则该扩展是强制性的。 - -- 如果 ``bool *`` 指向布尔值，则在启用扩展的情况下，该布尔值将更新为 ``true``\ 。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_suggested_tracker_names: - -.. rst-class:: classref-method - -:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| :ref:`🔗` - -返回扩展包装器中使用的位置跟踪器名称的 :ref:`PackedStringArray`\ 。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_viewport_composition_layer_extension_properties: - -.. rst-class:: classref-method - -:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| :ref:`🔗` - -获取表示属性的 :ref:`Dictionary` 数组，就像 :ref:`Object._get_property_list()` 一样，将被添加到 :ref:`OpenXRCompositionLayer` 节点。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_viewport_composition_layer_extension_property_defaults: - -.. rst-class:: classref-method - -:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| :ref:`🔗` - -获取一个 :ref:`Dictionary`\ ，其中包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性的默认值。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_before_instance_created: - -.. rst-class:: classref-method - -|void| **_on_before_instance_created**\ (\ ) |virtual| :ref:`🔗` - -在创建 OpenXR 实例之前调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_event_polled: - -.. rst-class:: classref-method - -:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| :ref:`🔗` - -当有 OpenXR 事件需要处理时调用。实现时，如果事件已被处理，则返回 ``true``\ ，否则返回 ``false``\ 。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_instance_created: - -.. rst-class:: classref-method - -|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| :ref:`🔗` - -在创建 OpenXR 实例后立即调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_instance_destroyed: - -.. rst-class:: classref-method - -|void| **_on_instance_destroyed**\ (\ ) |virtual| :ref:`🔗` - -在 OpenXR 实例被销毁之前调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_main_swapchains_created: - -.. rst-class:: classref-method - -|void| **_on_main_swapchains_created**\ (\ ) |virtual| :ref:`🔗` - -在主交换链（重新）创建后立即调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_post_draw_viewport: - -.. rst-class:: classref-method - -|void| **_on_post_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -给定视口渲染后立即调用。 - -\ **注意：**\ 此时绘制命令可能还在队列中，尚未执行。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_draw_viewport: - -.. rst-class:: classref-method - -|void| **_on_pre_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -给定视口渲染前立即调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_render: - -.. rst-class:: classref-method - -|void| **_on_pre_render**\ (\ ) |virtual| :ref:`🔗` - -在 XR 视口开始其渲染步进之前调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_process: - -.. rst-class:: classref-method - -|void| **_on_process**\ (\ ) |virtual| :ref:`🔗` - -作为 OpenXR 进程处理的一部分调用。这发生在主循环的一般和物理处理步进之前。在该步进中，控制器数据被查询并可供游戏逻辑使用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_register_metadata: - -.. rst-class:: classref-method - -|void| **_on_register_metadata**\ (\ ) |virtual| :ref:`🔗` - -允许扩展注册额外的控制器元数据。即使 OpenXR API 未被构造，也会调用该函数，因为元数据需要可供编辑器使用。 - -扩展还应该提供元数据，无论主机系统是否支持它们。控制器数据用于为可以访问相关硬件的用户设置动作映射。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_session_created: - -.. rst-class:: classref-method - -|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| :ref:`🔗` - -在创建 OpenXR 会话后立即调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_session_destroyed: - -.. rst-class:: classref-method - -|void| **_on_session_destroyed**\ (\ ) |virtual| :ref:`🔗` - -在 OpenXR 会话被销毁之前调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_exiting: - -.. rst-class:: classref-method - -|void| **_on_state_exiting**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为退出时调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_focused: - -.. rst-class:: classref-method - -|void| **_on_state_focused**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为聚焦时调用。该状态是游戏运行时的活动状态。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_idle: - -.. rst-class:: classref-method - -|void| **_on_state_idle**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为空闲时调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_loss_pending: - -.. rst-class:: classref-method - -|void| **_on_state_loss_pending**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为丢失挂起时调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_ready: - -.. rst-class:: classref-method - -|void| **_on_state_ready**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为就绪时调用。这意味着 OpenXR 已准备好建立会话。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_stopping: - -.. rst-class:: classref-method - -|void| **_on_state_stopping**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为停止时调用。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_synchronized: - -.. rst-class:: classref-method - -|void| **_on_state_synchronized**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为同步时调用。当应用程序失去焦点时，OpenXR 也会返回到该状态。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_visible: - -.. rst-class:: classref-method - -|void| **_on_state_visible**\ (\ ) |virtual| :ref:`🔗` - -当 OpenXR 会话状态被更改为可见时调用。这意味着 OpenXR 现在已准备好接收帧。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_viewport_composition_layer_destroyed: - -.. rst-class:: classref-method - -|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| :ref:`🔗` - -当通过 :ref:`OpenXRCompositionLayer` 创建的合成层被销毁时调用。 - -\ ``layer`` 是指向 ``XrCompositionLayerBaseHeader`` 结构的指针。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_android_surface_swapchain_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_android_surface_swapchain_create_info_and_get_next_pointer**\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -向由 :ref:`OpenXRCompositionLayer` 创建的合成层添加其他数据结构。 - -\ ``property_values`` 包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性值。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_hand_joint_locations_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -当每个手部跟踪器被创建时添加额外的数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_instance_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -创建 OpenXR 实例时添加额外的数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_projection_views_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_projection_views_and_get_next_pointer**\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -为 ``view_index`` 视图的投影视图添加的额外数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_session_create_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -创建 OpenXR 会话时添加额外的数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_swapchain_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -创建 OpenXR 交换链时添加额外的数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_system_properties_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -查询 OpenXR 系统能力时添加额外的数据结构。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_viewport_composition_layer_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -向由 :ref:`OpenXRCompositionLayer` 创建的合成层添加其他数据结构。 - -\ ``property_values`` 包含 :ref:`_get_viewport_composition_layer_extension_properties()` 返回的属性值。 - -\ ``layer`` 是指向 ``XrCompositionLayerBaseHeader`` 结构的指针。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_method_get_openxr_api: - -.. rst-class:: classref-method - -:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) :ref:`🔗` - -返回创建的 :ref:`OpenXRAPIExtension`\ ，可用于访问 OpenXR API。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_method_register_extension_wrapper: - -.. rst-class:: classref-method - -|void| **register_extension_wrapper**\ (\ ) :ref:`🔗` - -注册扩展程序。这应该发生在核心模块初始化级别。 +**OpenXRExtensionWrapperExtension** 允许使用 GDExtension 实现 OpenXR 扩展。扩展应该使用 :ref:`OpenXRExtensionWrapper.register_extension_wrapper()` 注册。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrfutureextension.rst b/classes/zh_CN/class_openxrfutureextension.rst new file mode 100644 index 0000000000..f05cb1e9ce --- /dev/null +++ b/classes/zh_CN/class_openxrfutureextension.rst @@ -0,0 +1,101 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRFutureExtension.xml. + +.. _class_OpenXRFutureExtension: + +OpenXRFutureExtension +===================== + +**继承：** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +OpenXR Future 扩展，允许使用异步 API。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +这是 OpenXR 中支持的扩展，能够让其他 OpenXR 扩展启动异步函数，在函数完成后获取回调。不应在 GDScript 中使用，但可以在 GDExtension 中访问。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_future`\ (\ future\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRFutureResult` | :ref:`register_future`\ (\ future\: :ref:`int`, on_success\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_OpenXRFutureExtension_method_cancel_future: + +.. rst-class:: classref-method + +|void| **cancel_future**\ (\ future\: :ref:`int`\ ) :ref:`🔗` + +取消正在进行中的 future。\ ``future`` 必须是此前启动异步函数 API 所返回的 ``XrFutureEXT`` 值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureExtension_method_is_active: + +.. rst-class:: classref-method + +:ref:`bool` **is_active**\ (\ ) |const| :ref:`🔗` + +如果 future 在所使用的 OpenXR 运行时中可用，则返回 ``true``\ 。该函数仅在 OpenXR 已被初始化后返回有效值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureExtension_method_register_future: + +.. rst-class:: classref-method + +:ref:`OpenXRFutureResult` **register_future**\ (\ future\: :ref:`int`, on_success\: :ref:`Callable` = Callable()\ ) :ref:`🔗` + +注册 OpenXR Future 对象，用于监视完成情况。\ ``future`` 必须是此前启动异步函数 API 所返回的 ``XrFutureEXT`` 值。 + +你还可以指定 ``on_success``\ ，会在 future 成功完成时调用。 + +你也可以用返回的 :ref:`OpenXRFutureResult` 对象来 ``await`` 它的 :ref:`OpenXRFutureResult.completed` 信号。 + +:: + + var future_result = OpenXRFutureExtension.register_future(future) + await future_result.completed + if future_result.get_status() == OpenXRFutureResult.RESULT_FINISHED: + # 处理成功的情况 + pass + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrfutureresult.rst b/classes/zh_CN/class_openxrfutureresult.rst new file mode 100644 index 0000000000..d280c67f9e --- /dev/null +++ b/classes/zh_CN/class_openxrfutureresult.rst @@ -0,0 +1,175 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRFutureResult.xml. + +.. _class_OpenXRFutureResult: + +OpenXRFutureResult +================== + +**继承：** :ref:`RefCounted` **<** :ref:`Object` + +结果对象，用于跟踪 OpenXR Future 对象的异步结果。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +结果对象，用于跟踪 OpenXR Future 对象的异步结果，你可以用这个对象来跟踪结果的状态。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_future`\ (\ ) | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_future`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_result_value`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ResultStatus` | :ref:`get_status`\ (\ ) |const| | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_result_value`\ (\ result_value\: :ref:`Variant`\ ) | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_OpenXRFutureResult_signal_completed: + +.. rst-class:: classref-signal + +**completed**\ (\ result\: :ref:`OpenXRFutureResult`\ ) :ref:`🔗` + +当异步函数完成或取消时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_OpenXRFutureResult_ResultStatus: + +.. rst-class:: classref-enumeration + +enum **ResultStatus**: :ref:`🔗` + +.. _class_OpenXRFutureResult_constant_RESULT_RUNNING: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_RUNNING** = ``0`` + +异步函数正在运行。 + +.. _class_OpenXRFutureResult_constant_RESULT_FINISHED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_FINISHED** = ``1`` + +异步函数已完成。 + +.. _class_OpenXRFutureResult_constant_RESULT_CANCELLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_CANCELLED** = ``2`` + +异步函数已取消。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_OpenXRFutureResult_method_cancel_future: + +.. rst-class:: classref-method + +|void| **cancel_future**\ (\ ) :ref:`🔗` + +取消该 future 对象，会打断并停止异步函数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_get_future: + +.. rst-class:: classref-method + +:ref:`int` **get_future**\ (\ ) |const| :ref:`🔗` + +返回与该结果相关的 ``XrFutureEXT`` 值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_get_result_value: + +.. rst-class:: classref-method + +:ref:`Variant` **get_result_value**\ (\ ) |const| :ref:`🔗` + +返回异步函数的结果值（如果由扩展设置）。结果值的类型取决于所调用的函数。请查阅相关函数的文档。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_get_status: + +.. rst-class:: classref-method + +:ref:`ResultStatus` **get_status**\ (\ ) |const| :ref:`🔗` + +返回结果的状态。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_set_result_value: + +.. rst-class:: classref-method + +|void| **set_result_value**\ (\ result_value\: :ref:`Variant`\ ) :ref:`🔗` + +存储我们向用户公开的结果值。 + +\ **注意：**\ 该方法仅应由实现异步函数的 OpenXR 扩展调用。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrhand.rst b/classes/zh_CN/class_openxrhand.rst index d1eeb37275..948e4aecde 100644 --- a/classes/zh_CN/class_openxrhand.rst +++ b/classes/zh_CN/class_openxrhand.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRHand.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRHand.xml. .. _class_OpenXRHand: @@ -281,6 +281,7 @@ enum **BoneUpdate**: :ref:`🔗` 设置 :ref:`hand_skeleton` 所兼容的骨架绑定类型。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrhapticbase.rst b/classes/zh_CN/class_openxrhapticbase.rst index 72f3af14e1..902b6afc02 100644 --- a/classes/zh_CN/class_openxrhapticbase.rst +++ b/classes/zh_CN/class_openxrhapticbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRHapticBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRHapticBase.xml. .. _class_OpenXRHapticBase: @@ -24,6 +24,7 @@ OpenXR 触觉反馈基类。 这是触觉反馈资源的基类。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrhapticvibration.rst b/classes/zh_CN/class_openxrhapticvibration.rst index 16f8575c87..e60fc17175 100644 --- a/classes/zh_CN/class_openxrhapticvibration.rst +++ b/classes/zh_CN/class_openxrhapticvibration.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRHapticVibration.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRHapticVibration.xml. .. _class_OpenXRHapticVibration: @@ -94,6 +94,7 @@ OpenXRHapticVibration 脉冲的频率，单位为赫兹。\ ``0.0`` 会让 XR 运行时为所使用的设备选择最佳频率。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrinteractionprofile.rst b/classes/zh_CN/class_openxrinteractionprofile.rst index 2e3ff90559..95605293a4 100644 --- a/classes/zh_CN/class_openxrinteractionprofile.rst +++ b/classes/zh_CN/class_openxrinteractionprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRInteractionProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfile.xml. .. _class_OpenXRInteractionProfile: @@ -167,6 +167,7 @@ OpenXRInteractionProfile 获取交互配置中绑定修改器的数量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrinteractionprofileeditor.rst b/classes/zh_CN/class_openxrinteractionprofileeditor.rst index d6f6905205..e65f548055 100644 --- a/classes/zh_CN/class_openxrinteractionprofileeditor.rst +++ b/classes/zh_CN/class_openxrinteractionprofileeditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRInteractionProfileEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfileEditor.xml. .. _class_OpenXRInteractionProfileEditor: @@ -22,6 +22,7 @@ OpenXRInteractionProfileEditor 这是默认的 OpenXR 交互配置编辑器，为编辑交互配置提供通用界面，未定义任何自定义编辑器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrinteractionprofileeditorbase.rst b/classes/zh_CN/class_openxrinteractionprofileeditorbase.rst index 441644dbbb..b1eb4a8395 100644 --- a/classes/zh_CN/class_openxrinteractionprofileeditorbase.rst +++ b/classes/zh_CN/class_openxrinteractionprofileeditorbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRInteractionProfileEditorBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfileEditorBase.xml. .. _class_OpenXRInteractionProfileEditorBase: @@ -67,6 +67,7 @@ OpenXRInteractionProfileEditorBase 使用给定的动作映射 ``action_map`` 和交互配置 ``interaction_profile`` 设置该编辑器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrinteractionprofilemetadata.rst b/classes/zh_CN/class_openxrinteractionprofilemetadata.rst index a86a924e22..61f27a3d58 100644 --- a/classes/zh_CN/class_openxrinteractionprofilemetadata.rst +++ b/classes/zh_CN/class_openxrinteractionprofilemetadata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml. .. _class_OpenXRInteractionProfileMetadata: @@ -99,6 +99,7 @@ OpenXRInteractionProfileMetadata 当顶级路径最终被 OpenXR 绑定时，\ :ref:`XRPositionalTracker` 被实例化以管理该设备的状态。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrinterface.rst b/classes/zh_CN/class_openxrinterface.rst index a71a024089..56219e9918 100644 --- a/classes/zh_CN/class_openxrinterface.rst +++ b/classes/zh_CN/class_openxrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInterface.xml. .. _class_OpenXRInterface: @@ -81,6 +81,8 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HandMotionRange` | :ref:`get_motion_range`\ (\ hand\: :ref:`Hand`\ ) |const| | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SessionState` | :ref:`get_session_state`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_set_active`\ (\ name\: :ref:`String`\ ) |const| | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_eye_gaze_interaction_supported`\ (\ ) | @@ -93,6 +95,10 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_action_set_active`\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cpu_level`\ (\ level\: :ref:`PerfSettingsLevel`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gpu_level`\ (\ level\: :ref:`PerfSettingsLevel`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_motion_range`\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,6 +111,30 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 信号 ---- +.. _class_OpenXRInterface_signal_cpu_level_changed: + +.. rst-class:: classref-signal + +**cpu_level_changed**\ (\ sub_domain\: :ref:`int`, from_level\: :ref:`int`, to_level\: :ref:`int`\ ) :ref:`🔗` + +告知设备 CPU 性能等级已在指定子域中发生改变。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_signal_gpu_level_changed: + +.. rst-class:: classref-signal + +**gpu_level_changed**\ (\ sub_domain\: :ref:`int`, from_level\: :ref:`int`, to_level\: :ref:`int`\ ) :ref:`🔗` + +告知设备 GPU 性能等级已在指定子域中发生改变。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_signal_instance_exiting: .. rst-class:: classref-signal @@ -161,7 +191,7 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 **session_focussed**\ (\ ) :ref:`🔗` -通知我们的 OpenXR 会话现在获得了焦点。 +通知我们的 OpenXR 会话现在获得了焦点，例如输出发送到了 HMD，我们正在获得 XR 输入。 .. rst-class:: classref-item-separator @@ -191,13 +221,25 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 ---- +.. _class_OpenXRInterface_signal_session_synchronized: + +.. rst-class:: classref-signal + +**session_synchronized**\ (\ ) :ref:`🔗` + +通知我们的 OpenXR 会话已经同步。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_signal_session_visible: .. rst-class:: classref-signal **session_visible**\ (\ ) :ref:`🔗` -通知我们的 OpenXR 会话现在可见（输出正在发送到 HMD）。 +通知我们的 OpenXR 会话现在可见，例如输出发送到了 HMD，但是我们还收不到 XR 输入。 .. rst-class:: classref-section-separator @@ -208,6 +250,92 @@ OpenXR 接口允许 Godot 与 OpenXR 运行时进行交互，并使创建 XR 体 枚举 ---- +.. _enum_OpenXRInterface_SessionState: + +.. rst-class:: classref-enumeration + +enum **SessionState**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_SESSION_STATE_UNKNOWN: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_UNKNOWN** = ``0`` + +会话的状态未知，我们尚未设置 OpenXR。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_IDLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_IDLE** = ``1`` + +OpenXR 会话创建和销毁后的初始状态。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_READY: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_READY** = ``2`` + +OpenXR 已准备好开始会话。进入该状态时会发出 :ref:`session_begun`\ 。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_SYNCHRONIZED: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_SYNCHRONIZED** = ``3`` + +应用已将其帧循环与运行时同步，但尚未进行渲染。进入该状态时会发出 :ref:`session_synchronized`\ 。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_VISIBLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_VISIBLE** = ``4`` + +应用已将其帧循环与运行时同步，且正在向用户渲染输出，但未收到用户输入。进入该状态时会发出 :ref:`session_visible`\ 。 + +\ **注意：**\ 这是获取焦点状态前的那个状态，出现在用户打开系统菜单、切换到其他应用、摘下头戴设备等情况。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_FOCUSED: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_FOCUSED** = ``5`` + +应用已将其帧循环与运行时同步，且正在向用户渲染输出并接收用户输入。进入该状态时会发出 :ref:`session_focussed`\ 。 + +\ **注意：**\ 这是用户能够与游戏完整交互时 OpenXR 所处的状态。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_STOPPING: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_STOPPING** = ``6`` + +会话已停止。进入该状态时会发出 :ref:`session_stopping`\ 。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_LOSS_PENDING: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_LOSS_PENDING** = ``7`` + +会话即将丢失。进入该状态时会发出 :ref:`session_loss_pending`\ 。 + +.. _class_OpenXRInterface_constant_SESSION_STATE_EXITING: + +.. rst-class:: classref-enumeration-constant + +:ref:`SessionState` **SESSION_STATE_EXITING** = ``8`` + +OpenXR 实例即将销毁，目前尚存在。进入该状态时会发出 :ref:`instance_exiting`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _enum_OpenXRInterface_Hand: .. rst-class:: classref-enumeration @@ -312,7 +440,7 @@ enum **HandTrackedSource**: :ref:`🔗` :ref:`HandTrackedSource` **HAND_TRACKED_SOURCE_MAX** = ``3`` -手部跟踪源枚举的最大值。 +代表 :ref:`HandTrackedSource` 枚举的大小。 .. rst-class:: classref-item-separator @@ -378,7 +506,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_INDEX_METACARPAL** = ``6`` -掌骨食指关节。 +食指掌骨关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_PROXIMAL: @@ -386,7 +514,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_INDEX_PROXIMAL** = ``7`` -食指近端关节。 +食指指骨近端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_INTERMEDIATE: @@ -394,7 +522,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_INDEX_INTERMEDIATE** = ``8`` -食指中间关节。 +食指指骨中间关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_DISTAL: @@ -402,7 +530,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_INDEX_DISTAL** = ``9`` -食指远端关节。 +食指指骨远端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_TIP: @@ -410,7 +538,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_INDEX_TIP** = ``10`` -食指尖端关节。 +食指指尖关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_METACARPAL: @@ -418,7 +546,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MIDDLE_METACARPAL** = ``11`` -掌骨中指关节。 +中指掌骨关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_PROXIMAL: @@ -426,7 +554,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MIDDLE_PROXIMAL** = ``12`` -中指近端关节。 +中指指骨近端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_INTERMEDIATE: @@ -434,7 +562,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MIDDLE_INTERMEDIATE** = ``13`` -中指中间关节。 +中指指骨中间关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_DISTAL: @@ -442,7 +570,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MIDDLE_DISTAL** = ``14`` -中指远端关节。 +中指指骨远端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_TIP: @@ -450,7 +578,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MIDDLE_TIP** = ``15`` -中指尖端关节。 +中指指尖关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_RING_METACARPAL: @@ -458,7 +586,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_RING_METACARPAL** = ``16`` -环指掌骨关节。 +无名指掌骨关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_RING_PROXIMAL: @@ -466,7 +594,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_RING_PROXIMAL** = ``17`` -环指近端关节。 +无名指指骨近端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_RING_INTERMEDIATE: @@ -474,7 +602,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_RING_INTERMEDIATE** = ``18`` -环指中间关节。 +无名指指骨中间关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_RING_DISTAL: @@ -482,7 +610,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_RING_DISTAL** = ``19`` -环指远端关节。 +无名指指骨远端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_RING_TIP: @@ -490,7 +618,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_RING_TIP** = ``20`` -环指尖端关节。 +无名指指尖关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_METACARPAL: @@ -498,7 +626,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_LITTLE_METACARPAL** = ``21`` -掌骨小指关节。 +小指掌骨关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_PROXIMAL: @@ -506,7 +634,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_LITTLE_PROXIMAL** = ``22`` -小指近端关节。 +小指指骨近端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_INTERMEDIATE: @@ -514,7 +642,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_LITTLE_INTERMEDIATE** = ``23`` -小指中间关节。 +小指指骨中间关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_DISTAL: @@ -522,7 +650,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_LITTLE_DISTAL** = ``24`` -小指远端关节。 +小指指骨远端关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_TIP: @@ -530,7 +658,7 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_LITTLE_TIP** = ``25`` -小指尖端关节。 +小指指尖关节。 .. _class_OpenXRInterface_constant_HAND_JOINT_MAX: @@ -538,7 +666,117 @@ enum **HandJoints**: :ref:`🔗` :ref:`HandJoints` **HAND_JOINT_MAX** = ``26`` -手关节枚举的最大值。 +代表 :ref:`HandJoints` 枚举的大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsLevel: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsLevel**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_POWER_SAVINGS: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_POWER_SAVINGS** = ``0`` + +应用程序进入了非 XR 段落（锁定头部或静态屏幕），在此期间节能优先。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_LOW: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_SUSTAINED_LOW** = ``1`` + +应用程序进入了稳定且低复杂度的段落，在此期间降低能耗比偶尔推迟渲染帧更重要。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_SUSTAINED_HIGH** = ``2`` + +应用程序进入了动态且高复杂度的段落，在此期间 XR 运行时会努力在热量可持续范围内实现一致的 XR 合成和帧渲染。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_BOOST: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_BOOST** = ``3`` + +应用程序进入了极高复杂度的段落，在此期间 XR 运行时允许越过热量可持续范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsSubDomain: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsSubDomain**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_COMPOSITING** = ``0`` + +运行时的合成性能达到了新的等级。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_RENDERING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_RENDERING** = ``1`` + +应用程序的渲染性能达到了新的等级。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_THERMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_THERMAL** = ``2`` + +设备的温度达到了新的等级。 + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsNotificationLevel: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsNotificationLevel**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_NORMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_NORMAL** = ``0`` + +子域已达到除了当前采取的措施外不再需要进一步行动的水平。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_WARNING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_WARNING** = ``1`` + +子域已达到预警水平，应用程序应该开始采取主动的缓解措施。 + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED** = ``2`` + +子域已达到危急水平，应用程序应该开始采取严厉的缓解措施。 .. rst-class:: classref-item-separator @@ -864,6 +1102,18 @@ flags **HandJointFlags**: :ref:`🔗` ---- +.. _class_OpenXRInterface_method_get_session_state: + +.. rst-class:: classref-method + +:ref:`SessionState` **get_session_state**\ (\ ) :ref:`🔗` + +返回 OpenXR 会话的当前状态。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_method_is_action_set_active: .. rst-class:: classref-method @@ -944,6 +1194,30 @@ flags **HandJointFlags**: :ref:`🔗` ---- +.. _class_OpenXRInterface_method_set_cpu_level: + +.. rst-class:: classref-method + +|void| **set_cpu_level**\ (\ level\: :ref:`PerfSettingsLevel`\ ) :ref:`🔗` + +设置 OpenXR 设备的 CPU 性能等级。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_method_set_gpu_level: + +.. rst-class:: classref-method + +|void| **set_gpu_level**\ (\ level\: :ref:`PerfSettingsLevel`\ ) :ref:`🔗` + +设置 OpenXR 设备的 GPU 性能等级。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_method_set_motion_range: .. rst-class:: classref-method @@ -953,6 +1227,7 @@ flags **HandJointFlags**: :ref:`🔗` 如果启用了手部跟踪并且支持运动范围，请将 ``hand`` 当前配置的运动范围设置为 ``motion_range``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxripbinding.rst b/classes/zh_CN/class_openxripbinding.rst index 281aa57fd1..572df16d60 100644 --- a/classes/zh_CN/class_openxripbinding.rst +++ b/classes/zh_CN/class_openxripbinding.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRIPBinding.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRIPBinding.xml. .. _class_OpenXRIPBinding: @@ -226,6 +226,7 @@ OpenXRIPBinding 从该绑定中移除该输入/输出路径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxripbindingmodifier.rst b/classes/zh_CN/class_openxripbindingmodifier.rst index f75ed2fee9..640cb5a97f 100644 --- a/classes/zh_CN/class_openxripbindingmodifier.rst +++ b/classes/zh_CN/class_openxripbindingmodifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRIPBindingModifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRIPBindingModifier.xml. .. _class_OpenXRIPBindingModifier: @@ -24,6 +24,7 @@ OpenXRIPBindingModifier 直接应用于某个交互配置的绑定修改器。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_openxrrendermodel.rst b/classes/zh_CN/class_openxrrendermodel.rst new file mode 100644 index 0000000000..1f069db975 --- /dev/null +++ b/classes/zh_CN/class_openxrrendermodel.rst @@ -0,0 +1,114 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRRenderModel.xml. + +.. _class_OpenXRRenderModel: + +OpenXRRenderModel +================= + +**继承：** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +该节点会显示 OpenXR 渲染模型。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +该节点会显示 OpenXR 渲染模型，访问与之关联的 GLTF 并处理所有动画数据（需要 XR 运行时支持）。 + +引入渲染模型是为了正确显示用户手中控制器（或其他设备）的模型，因为 OpenXR 动作映射并不会提供用户所使用的硬件的信息。请注意，虽然可以根据绑定的动作映射配置从一定程度上推测控制器（或设备），这种做法并不安全，因为用户所使用的可能是开发时未知的硬件，此时 OpenXR 就会模拟可用的交互配置。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------+--------------------------------------------------------------------+-----------+ + | :ref:`RID` | :ref:`render_model` | ``RID()`` | + +-----------------------+--------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------+--------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_top_level_path`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_OpenXRRenderModel_signal_render_model_top_level_path_changed: + +.. rst-class:: classref-signal + +**render_model_top_level_path_changed**\ (\ ) :ref:`🔗` + +渲染模型的顶层路径发生改变时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_OpenXRRenderModel_property_render_model: + +.. rst-class:: classref-property + +:ref:`RID` **render_model** = ``RID()`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_render_model**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_render_model**\ (\ ) + +要加载的渲染模型的 RID，由 :ref:`OpenXRRenderModelExtension.render_model_create()` 或 :ref:`OpenXRRenderModelExtension.render_model_get_all()` 返回。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_OpenXRRenderModel_method_get_top_level_path: + +.. rst-class:: classref-method + +:ref:`String` **get_top_level_path**\ (\ ) |const| :ref:`🔗` + +返回与该渲染模型相关的顶层路径。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrrendermodelextension.rst b/classes/zh_CN/class_openxrrendermodelextension.rst new file mode 100644 index 0000000000..c92b0b1e50 --- /dev/null +++ b/classes/zh_CN/class_openxrrendermodelextension.rst @@ -0,0 +1,278 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml. + +.. _class_OpenXRRenderModelExtension: + +OpenXRRenderModelExtension +========================== + +**继承：** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +这个类实现了 OpenXR 渲染模型扩展。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +这个类实现了 OpenXR 渲染模型扩展，启用后会维护活动渲染模型列表，提供渲染模型数据接口。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`render_model_create`\ (\ render_model_id\: :ref:`int`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`render_model_destroy`\ (\ render_model\: :ref:`RID`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`render_model_get_all`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`render_model_get_animatable_node_count`\ (\ render_model\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`render_model_get_animatable_node_name`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`render_model_get_animatable_node_transform`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TrackingConfidence` | :ref:`render_model_get_confidence`\ (\ render_model\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`render_model_get_root_transform`\ (\ render_model\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`render_model_get_subaction_paths`\ (\ render_model\: :ref:`RID`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`render_model_get_top_level_path`\ (\ render_model\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`render_model_is_animatable_node_visible`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node3D` | :ref:`render_model_new_scene_instance`\ (\ render_model\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_OpenXRRenderModelExtension_signal_render_model_added: + +.. rst-class:: classref-signal + +**render_model_added**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` + +添加新的渲染模型时发出。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_signal_render_model_removed: + +.. rst-class:: classref-signal + +**render_model_removed**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` + +移除渲染模型时发出。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_signal_render_model_top_level_path_changed: + +.. rst-class:: classref-signal + +**render_model_top_level_path_changed**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` + +与渲染模型关联的顶层路径发生改变时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_OpenXRRenderModelExtension_method_is_active: + +.. rst-class:: classref-method + +:ref:`bool` **is_active**\ (\ ) |const| :ref:`🔗` + +如果支持且已启用 OpenXR 的渲染模型，则返回 ``true``\ 。 + +\ **注意：**\ 这仅在 OpenXR 已被初始化后返回一个有效值。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_create: + +.. rst-class:: classref-method + +:ref:`RID` **render_model_create**\ (\ render_model_id\: :ref:`int`\ ) :ref:`🔗` + +在 OpenXR 中使用渲染模型 ID 创建一个渲染模型对象。 + +\ **注意：**\ 该函数是为提供渲染模型 ID 的依赖 OpenXR 扩展公开的，以便与渲染模型扩展一起使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_destroy: + +.. rst-class:: classref-method + +|void| **render_model_destroy**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` + +销毁在 OpenXR 中之前使用 :ref:`render_model_create()` 创建的渲染模型对象。 + +\ **注意：**\ 该函数是为提供渲染模型 ID 的依赖 OpenXR 扩展公开的，以便与渲染模型扩展一起使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_all: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`RID`\] **render_model_get_all**\ (\ ) :ref:`🔗` + +返回已向该扩展注册的所有当前活动的渲染模型数组。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_count: + +.. rst-class:: classref-method + +:ref:`int` **render_model_get_animatable_node_count**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回该渲染模型中包含的可动画节点数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_name: + +.. rst-class:: classref-method + +:ref:`String` **render_model_get_animatable_node_name**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回给定可动画节点的名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_transform: + +.. rst-class:: classref-method + +:ref:`Transform3D` **render_model_get_animatable_node_transform**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回可动画节点的当前局部变换。每帧都会更新。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_confidence: + +.. rst-class:: classref-method + +:ref:`TrackingConfidence` **render_model_get_confidence**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回渲染模型跟踪数据的跟踪置信度。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_root_transform: + +.. rst-class:: classref-method + +:ref:`Transform3D` **render_model_get_root_transform**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回渲染模型的根变换。这是跟踪的位置，相对于 :ref:`XROrigin3D` 节点。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_subaction_paths: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **render_model_get_subaction_paths**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` + +返回 ``render_model`` 的活动子动作路径列表。 + +\ **注意：**\ 如果与动作绑定的设备与建议的交互绑定不同，则返回的信息显示的是与该设备模拟的交互绑定相关的路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_get_top_level_path: + +.. rst-class:: classref-method + +:ref:`String` **render_model_get_top_level_path**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回与 ``render_model`` 关联的顶级路径。如果提供了该信息，则可以识别渲染模型是否与玩家的手或其他身体部位相关联。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_is_animatable_node_visible: + +.. rst-class:: classref-method + +:ref:`bool` **render_model_is_animatable_node_visible**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +如果动画节点应当可见，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelExtension_method_render_model_new_scene_instance: + +.. rst-class:: classref-method + +:ref:`Node3D` **render_model_new_scene_instance**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回包含显示渲染模型所需的所有 :ref:`MeshInstance3D` 的子场景实例。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrrendermodelmanager.rst b/classes/zh_CN/class_openxrrendermodelmanager.rst new file mode 100644 index 0000000000..d8971e7d9f --- /dev/null +++ b/classes/zh_CN/class_openxrrendermodelmanager.rst @@ -0,0 +1,163 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRRenderModelManager.xml. + +.. _class_OpenXRRenderModelManager: + +OpenXRRenderModelManager +======================== + +**继承：** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +辅助节点，能够自动管理渲染模型的显示。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +这个辅助接点会自动管理渲染模型的显示。检测到控制器等手持设备时会新建 :ref:`OpenXRRenderModel` 节点，设备失效时会将对应节点移除。 + +\ **注意：**\ 如果想要进一步控制相关逻辑，你也可以调用 :ref:`OpenXRRenderModelExtension.render_model_get_all()` 获取活动渲染模型的 ID 列表，为各个渲染模型 ID 创建 :ref:`OpenXRRenderModel` 实例。 + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------+--------+ + | :ref:`String` | :ref:`make_local_to_pose` | ``""`` | + +-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------+--------+ + | :ref:`RenderModelTracker` | :ref:`tracker` | ``0`` | + +-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------+--------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +信号 +---- + +.. _class_OpenXRRenderModelManager_signal_render_model_added: + +.. rst-class:: classref-signal + +**render_model_added**\ (\ render_model\: :ref:`OpenXRRenderModel`\ ) :ref:`🔗` + +渲染模型节点添加为该节点的子节点时发出。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelManager_signal_render_model_removed: + +.. rst-class:: classref-signal + +**render_model_removed**\ (\ render_model\: :ref:`OpenXRRenderModel`\ ) :ref:`🔗` + +渲染模型子节点即将从该节点下移除时发出。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +枚举 +---- + +.. _enum_OpenXRRenderModelManager_RenderModelTracker: + +.. rst-class:: classref-enumeration + +enum **RenderModelTracker**: :ref:`🔗` + +.. _class_OpenXRRenderModelManager_constant_RENDER_MODEL_TRACKER_ANY: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderModelTracker` **RENDER_MODEL_TRACKER_ANY** = ``0`` + +显示所有活动的渲染模型，无论其与什么跟踪器相关。 + +.. _class_OpenXRRenderModelManager_constant_RENDER_MODEL_TRACKER_NONE_SET: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderModelTracker` **RENDER_MODEL_TRACKER_NONE_SET** = ``1`` + +仅显示与所管理的跟踪器无关的活动渲染模型。 + +.. _class_OpenXRRenderModelManager_constant_RENDER_MODEL_TRACKER_LEFT_HAND: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderModelTracker` **RENDER_MODEL_TRACKER_LEFT_HAND** = ``2`` + +仅显示与左手跟踪器相关的活动渲染模型。 + +.. _class_OpenXRRenderModelManager_constant_RENDER_MODEL_TRACKER_RIGHT_HAND: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderModelTracker` **RENDER_MODEL_TRACKER_RIGHT_HAND** = ``3`` + +仅显示与右手跟踪器相关的活动渲染模型。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_OpenXRRenderModelManager_property_make_local_to_pose: + +.. rst-class:: classref-property + +:ref:`String` **make_local_to_pose** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_make_local_to_pose**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_make_local_to_pose**\ (\ ) + +将渲染模型的位置设置为相对于该姿势（会对渲染模型容器节点的位置进行调整）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRRenderModelManager_property_tracker: + +.. rst-class:: classref-property + +:ref:`RenderModelTracker` **tracker** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tracker**\ (\ value\: :ref:`RenderModelTracker`\ ) +- :ref:`RenderModelTracker` **get_tracker**\ (\ ) + +将渲染模型限制到指定的跟踪器：0 = 所有渲染模型，1 = 渲染模型与某个跟踪器无关，2 = 渲染模型与左手跟踪器相关，3 = 渲染模型与右手跟踪器相关。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_openxrvisibilitymask.rst b/classes/zh_CN/class_openxrvisibilitymask.rst index 3274455025..adf0284c29 100644 --- a/classes/zh_CN/class_openxrvisibilitymask.rst +++ b/classes/zh_CN/class_openxrvisibilitymask.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/openxr/doc_classes/OpenXRVisibilityMask.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRVisibilityMask.xml. .. _class_OpenXRVisibilityMask: @@ -24,6 +24,7 @@ OpenXRVisibilityMask 由于可见遮罩是第一个渲染的，因此可以避免处理光照计算昂贵的片段，因为这些片段会通过 Z 检查丢弃。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_optimizedtranslation.rst b/classes/zh_CN/class_optimizedtranslation.rst index 28b48ace0b..9e9dc99ac0 100644 --- a/classes/zh_CN/class_optimizedtranslation.rst +++ b/classes/zh_CN/class_optimizedtranslation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OptimizedTranslation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OptimizedTranslation.xml. .. _class_OptimizedTranslation: @@ -53,6 +53,7 @@ OptimizedTranslation \ **注意：**\ 该方法适于在编辑器中使用。在导出后的项目中调用无效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_optionbutton.rst b/classes/zh_CN/class_optionbutton.rst index 95afda1aed..baa529f927 100644 --- a/classes/zh_CN/class_optionbutton.rst +++ b/classes/zh_CN/class_optionbutton.rst @@ -1,12 +1,12 @@ :github_url: hide .. meta:: - :keywords: select + :keywords: select, dropdown .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OptionButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OptionButton.xml. .. _class_OptionButton: @@ -26,7 +26,7 @@ OptionButton 另见 :ref:`BaseButton`\ ，其中包含与此节点相关联的通用属性和方法。 -\ **注意：**\ 菜单项的 ID 值有 32 位的限制，并不是完整的 64 位 :ref:`int`\ 。取值范围为 ``-2^32`` 到 ``2^32 - 1``\ ，即 ``-2147483648`` 到 ``2147483647``\ 。 +\ **注意：**\ 菜单项的 ID 限制为带符号 32 位整数，并不是完整的 64 位 :ref:`int`\ 。取值范围为 ``-2^31`` 到 ``2^31 - 1``\ ，即 ``-2147483648`` 到 ``2147483647``\ 。 \ **注意：**\ :ref:`Button.text` 和 :ref:`Button.icon` 属性会根据当前所选菜单项自动设置。不应该手动更改。 @@ -62,61 +62,65 @@ OptionButton .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_separator`\ (\ text\: :ref:`String` = ""\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selectable_item`\ (\ from_last\: :ref:`bool` = false\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selected_id`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_selected_metadata`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selectable_items`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ idx\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_id`\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`show_popup`\ (\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ text\: :ref:`String` = ""\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_item_auto_translate_mode`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selectable_item`\ (\ from_last\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selected_id`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_selected_metadata`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selectable_items`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_auto_translate_mode`\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_popup`\ (\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -256,6 +260,8 @@ OptionButton 添加一个菜单项，图标为 ``texture``\ ，文本为 ``label``\ ，（可选）ID 为 ``id``\ 。如果没有传入 ``id``\ ，则会将菜单项的索引用作 ID。新菜单项会追加到末尾。 +\ **注意：**\ 没有其他菜单项时会选中该菜单项。 + .. rst-class:: classref-item-separator ---- @@ -268,6 +274,8 @@ OptionButton 添加一个菜单项，文本为 ``label``\ ，（可选）ID 为 ``id``\ 。如果没有传入 ``id``\ ，则会将菜单项的索引用作 ID。新菜单项会追加到末尾。 +\ **注意：**\ 没有其他菜单项时会选中该菜单项。 + .. rst-class:: classref-item-separator ---- @@ -296,6 +304,18 @@ OptionButton ---- +.. _class_OptionButton_method_get_item_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_item_auto_translate_mode**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``idx`` 的菜单项的自动翻译模式。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_method_get_item_icon: .. rst-class:: classref-method @@ -494,6 +514,20 @@ OptionButton ---- +.. _class_OptionButton_method_set_item_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_item_auto_translate_mode**\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`🔗` + +设置索引为 ``idx`` 的菜单项的自动翻译模式。 + +菜单项使用 :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT`\ ，表示使用与 **OptionButton** 相同的自动翻译模式。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_method_set_item_disabled: .. rst-class:: classref-method @@ -618,6 +652,7 @@ OptionButton 要绘制在按钮右侧的箭头图标。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_ormmaterial3d.rst b/classes/zh_CN/class_ormmaterial3d.rst index ff558d90f0..5a5f2ec508 100644 --- a/classes/zh_CN/class_ormmaterial3d.rst +++ b/classes/zh_CN/class_ormmaterial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ORMMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ORMMaterial3D.xml. .. _class_ORMMaterial3D: @@ -29,6 +29,7 @@ ORMMaterial3D 的属性继承自 :ref:`BaseMaterial3D`\ - :doc:`标准 3D 材质与 ORM 3D 材质 <../tutorials/3d/standard_material_3d>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_os.rst b/classes/zh_CN/class_os.rst index f9bf93439a..eef0a06b1c 100644 --- a/classes/zh_CN/class_os.rst +++ b/classes/zh_CN/class_os.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/OS.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OS.xml. .. _class_OS: @@ -54,6 +54,8 @@ OS .. table:: :widths: auto + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_logger`\ (\ logger\: :ref:`Logger`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`alert`\ (\ text\: :ref:`String`, title\: :ref:`String` = "Alert!"\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -179,9 +181,13 @@ OS +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`open_midi_inputs`\ (\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`read_buffer_from_stdin`\ (\ buffer_size\: :ref:`int`\ ) | + | :ref:`Error` | :ref:`open_with_program`\ (\ program_path\: :ref:`String`, paths\: :ref:`PackedStringArray`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`read_string_from_stdin`\ (\ buffer_size\: :ref:`int`\ ) | + | :ref:`PackedByteArray` | :ref:`read_buffer_from_stdin`\ (\ buffer_size\: :ref:`int` = 1024\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`read_string_from_stdin`\ (\ buffer_size\: :ref:`int` = 1024\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_logger`\ (\ logger\: :ref:`Logger`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`request_permission`\ (\ name\: :ref:`String`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -446,6 +452,18 @@ enum **StdHandleType**: :ref:`🔗` 方法说明 -------- +.. _class_OS_method_add_logger: + +.. rst-class:: classref-method + +|void| **add_logger**\ (\ logger\: :ref:`Logger`\ ) :ref:`🔗` + +添加自定义日志记录器，拦截内部消息流。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_alert: .. rst-class:: classref-method @@ -789,7 +807,7 @@ enum **StdHandleType**: :ref:`🔗` # Godot 使用以下命令执行： # godot --fullscreen -- --level=2 --hardcore - + OS.get_cmdline_args() # 返回 ["--fullscreen", "--level=2", "--hardcore"] OS.get_cmdline_user_args() # 返回 ["--level=2", "--hardcore"] @@ -919,7 +937,9 @@ enum **StdHandleType**: :ref:`🔗` 在 Android 设备上：返回已授予的危险权限列表。 -在 macOS 上：返回应用程序可访问的用户选择的文件夹列表（仅限沙盒应用程序）。使用原生文件对话框请求文件夹访问权限。 +在 macOS 上：返回已授予权限列表以及应用程序可访问的用户选择的文件夹列表（仅限沙盒应用程序）。使用原生文件对话框请求文件夹访问权限。 + +在 iOS、visionOS 上：返回已授予权限列表。 .. rst-class:: classref-item-separator @@ -1149,7 +1169,7 @@ enum **StdHandleType**: :ref:`🔗` 返回主机用来唯一标识该应用程序的编号。 -\ **注意：**\ 该方法在 Android、iOS、Linux、macOS 和 Windows 上实现。 +\ **注意：**\ 该方法在 Web 上始终返回 ``0``\ 。 .. rst-class:: classref-item-separator @@ -1225,6 +1245,8 @@ enum **StdHandleType**: :ref:`🔗` 返回标准错误设备的类型。 +\ **注意：**\ 该方法在 Linux、macOS、Windows 上实现。 + .. rst-class:: classref-item-separator ---- @@ -1237,6 +1259,10 @@ enum **StdHandleType**: :ref:`🔗` 返回标准输入设备的类型。 +\ **注意：**\ 该方法在 Linux、macOS、Windows 上实现。 + +\ **注意：**\ 在导出的 Windows 构建中，要访问标准输入请运行控制台包装可执行文件。如果需要具有完整控制台支持的独立可执行文件，请使用带有 ``windows_subsystem=console`` 标志进行编译的自定义构建。 + .. rst-class:: classref-item-separator ---- @@ -1249,6 +1275,8 @@ enum **StdHandleType**: :ref:`🔗` 返回标准输出设备的类型。 +\ **注意：**\ 该方法在 Linux、macOS、Windows 上实现。 + .. rst-class:: classref-item-separator ---- @@ -1409,7 +1437,7 @@ enum **StdHandleType**: :ref:`🔗` 返回操作系统的确切生产和构建版本。这与营销中使用的品牌版本不同。这有助于区分操作系统的不同版本，包括次要版本、内部版本和自定义版本。 -- 对于 Windows，返回主要和次要版本，以及构建号。例如，对于 Windows 10 版本，返回的字符串可能看起来像 ``10.0.9926``\ ，对于 Windows 7 SP1 版本，它可能看起来像 ``6.1.7601``\ 。 +- 对于 Windows，返回主要和次要版本，以及构建号。例如对于 Windows 10 版本，返回的字符串可能看起来像 ``10.0.9926``\ 。 - 对于滚动发行版，例如 Arch Linux，会返回一个空字符串。 @@ -1429,9 +1457,11 @@ enum **StdHandleType**: :ref:`🔗` :ref:`String` **get_version_alias**\ (\ ) |const| :ref:`🔗` -返回用于营销的品牌版本，后接构建号（Windows 上）或版本号（macOS 上）。例如 ``11 (build 22000)`` 和 ``Sequoia (15.0.0)``\ 。这个值可以附加到 :ref:`get_name()` 后面，获取该操作系统完整、人类可读的操作系统名称和版本组合。“24H2”等 Windows 功能更新不包含在结果字符串中，但会识别 Windows Server（例如 ``2025 (build 26100)`` 表示 Windows Server 2025）。 +返回用于营销的品牌版本，后接构建号（Windows 上）、版本号（macOS 上）或 SDK 版本和小构建号（Android 上）。例如 ``11 (build 22000)``\ 、\ ``Sequoia (15.0.0)``\ 、\ ``15 (SDK 35 build abc528-11988f)``\ 。 -\ **注意：**\ 该方法仅在 Windows 和 macOS 上支持。在其他操作系统上返回值与 :ref:`get_version()` 相同。 +这个值可以附加到 :ref:`get_name()` 后面，获取该操作系统完整、人类可读的操作系统名称和版本组合。“24H2”等 Windows 功能更新不包含在结果字符串中，但会识别 Windows Server（例如 ``2025 (build 26100)`` 表示 Windows Server 2025）。 + +\ **注意：**\ 该方法仅在 Windows、macOS、Android 上支持。在其他操作系统上返回值与 :ref:`get_version()` 相同。 .. rst-class:: classref-item-separator @@ -1443,13 +1473,37 @@ enum **StdHandleType**: :ref:`🔗` :ref:`PackedStringArray` **get_video_adapter_driver_info**\ (\ ) |const| :ref:`🔗` -返回用户当前激活的显卡的视频适配器驱动程序名称和版本，返回为一个 :ref:`PackedStringArray`\ 。另见 :ref:`RenderingServer.get_video_adapter_api_version()`\ 。 +Returns the video adapter driver name and version for the user's currently active graphics card, as a :ref:`PackedStringArray`. See also :ref:`RenderingServer.get_video_adapter_api_version()`. -第一个元素保存驱动程序的名称，如 ``nvidia``\ 、\ ``amdgpu`` 等。 +The first element holds the driver name, such as ``nvidia``, ``amdgpu``, etc. + +The second element holds the driver version. For example, on the ``nvidia`` driver on a Linux/BSD platform, the version is in the format ``510.85.02``. For Windows, the driver's format is ``31.0.15.1659``. + +\ **Note:** This method is only supported on Linux/BSD and Windows when not running in headless mode. On other platforms, it returns an empty array. + +\ **Note:** This method will run slowly the first time it is called in a session; it can take several seconds depending on the operating system and hardware. It is blocking if called on the main thread, so it's recommended to call it on a separate thread using :ref:`Thread`. This allows the engine to keep running while the information is being retrieved. However, :ref:`get_video_adapter_driver_info()` is *not* thread-safe, so it should not be called from multiple threads at the same time. + + +.. tabs:: + + .. code-tab:: gdscript + + var thread = Thread.new() + + func _ready(): + thread.start( + func(): + var driver_info = OS.get_video_adapter_driver_info() + if not driver_info.is_empty(): + print("Driver: %s %s" % [driver_info[0], driver_info[1]]) + else: + print("Driver: (unknown)") + ) + + func _exit_tree(): + thread.wait_to_finish() -第二个元素保存驱动程序的版本。例如 Linux/BSD 平台上的 ``nvidia`` 驱动程序，其版本格式为 ``510.85.02``\ 。对于 Windows，其驱动程序的格式是 ``31.0.15.1659``\ 。 -\ **注意：**\ 该方法仅在 Linux/BSD 和 Windows 上不以无头模式运行时才受支持。在其他平台上，它返回一个空数组。 .. rst-class:: classref-item-separator @@ -1665,13 +1719,29 @@ enum **StdHandleType**: :ref:`🔗` ---- +.. _class_OS_method_open_with_program: + +.. rst-class:: classref-method + +:ref:`Error` **open_with_program**\ (\ program_path\: :ref:`String`, paths\: :ref:`PackedStringArray`\ ) :ref:`🔗` + +使用指定的应用程序打开一个或多个文件/目录。\ ``program_path`` 指定的是用来打开文件的应用程序路径，\ ``paths`` 中包含的是要打开的文件/目录的数组。 + +\ **注意：**\ 大多数情况下只有 macOS 上使用 :ref:`create_process()` 可能失败才需要使用该函数。其他平台会使用 :ref:`create_process()` 作为回退实现。 + +\ **注意：**\ 在 macOS 上，理想情况下 ``program_path`` 应该是 ``.app`` 捆绑包的路径。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_read_buffer_from_stdin: .. rst-class:: classref-method -:ref:`PackedByteArray` **read_buffer_from_stdin**\ (\ buffer_size\: :ref:`int`\ ) :ref:`🔗` +:ref:`PackedByteArray` **read_buffer_from_stdin**\ (\ buffer_size\: :ref:`int` = 1024\ ) :ref:`🔗` -从标准输入读取用户输入的原始数据字符串。这个操作是\ *阻塞的* ，如果在主线程上调用 :ref:`read_string_from_stdin()` 就会导致窗口冻结。 +从标准输入读取用户输入的原始数据字符串。这个操作是\ *阻塞的* ，如果在主线程上调用 :ref:`read_buffer_from_stdin()` 就会导致窗口冻结。 - 如果标准输入为控制台，则该方法会阻塞到程序在标准输入中接收到换行（通常是用户按下了 :kbd:`Enter`\ ）。 @@ -1691,7 +1761,7 @@ enum **StdHandleType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`String` **read_string_from_stdin**\ (\ buffer_size\: :ref:`int`\ ) :ref:`🔗` +:ref:`String` **read_string_from_stdin**\ (\ buffer_size\: :ref:`int` = 1024\ ) :ref:`🔗` 从标准输入读取用户输入。这个操作可能导致\ *阻塞* ，如果是在主线程上调用的 :ref:`read_string_from_stdin()`\ ，就会导致窗口冻结。 @@ -1711,6 +1781,18 @@ enum **StdHandleType**: :ref:`🔗` ---- +.. _class_OS_method_remove_logger: + +.. rst-class:: classref-method + +|void| **remove_logger**\ (\ logger\: :ref:`Logger`\ ) :ref:`🔗` + +移除由 :ref:`add_logger()` 添加的自定义日志记录器。 + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_request_permission: .. rst-class:: classref-method @@ -1725,9 +1807,13 @@ enum **StdHandleType**: :ref:`🔗` - ``OS.request_permission("android.permission.POST_NOTIFICATIONS")``\ -\ **注意：**\ 导出时必须检查权限。 +- ``OS.request_permission("macos.permission.RECORD_SCREEN")``\ -\ **注意：**\ 该方法仅在 Android 上实现。 +- ``OS.request_permission("appleembedded.permission.AUDIO_RECORD")``\ + +\ **注意：**\ 在 Android 上，导出时必须设置权限。 + +\ **注意：**\ 该方法在 Android、macOS、visionOS 上实现。 .. rst-class:: classref-item-separator @@ -1874,6 +1960,7 @@ enum **StdHandleType**: :ref:`🔗` \ **注意：**\ 环境变量名称在除 Windows 以外的所有平台上都区分大小写。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedbytearray.rst b/classes/zh_CN/class_packedbytearray.rst index 81f68f3d55..3f9e7b324e 100644 --- a/classes/zh_CN/class_packedbytearray.rst +++ b/classes/zh_CN/class_packedbytearray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedByteArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedByteArray.xml. .. _class_PackedByteArray: @@ -21,7 +21,7 @@ PackedByteArray \ **PackedByteArray** 还提供了将各种类型编码为字节/从字节解码的方法。值的编码方式是实现细节，在与外部应用程序交互时不应依赖它。 -\ **注意：**\ 打包数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。这些返回的打包数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -58,6 +58,12 @@ PackedByteArray +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap16`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap32`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap64`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`compress`\ (\ compression_mode\: :ref:`int` = 0\ ) |const| | @@ -120,6 +126,8 @@ PackedByteArray +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`encode_var`\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | @@ -128,6 +136,8 @@ PackedByteArray +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_ascii`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_multibyte_char`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_utf8`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_utf16`\ (\ ) |const| | @@ -164,6 +174,8 @@ PackedByteArray +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sort`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`to_color_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`to_float32_array`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`to_float64_array`\ (\ ) |const| | @@ -172,6 +184,12 @@ PackedByteArray +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`to_int64_array`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`to_vector2_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`to_vector3_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`to_vector4_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -275,6 +293,42 @@ PackedByteArray ---- +.. _class_PackedByteArray_method_bswap16: + +.. rst-class:: classref-method + +|void| **bswap16**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +对数组中从偏移量为 ``offset`` 处开始的 ``count`` 个 16 位段落进行字节顺序交换的操作。交换是原地进行的。如果 ``count`` 小于零，则会处理到数组结尾为止，如果处理的数据大小不是 2 的倍数，则处理的最后一个 16 位段落之后的字节不会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_bswap32: + +.. rst-class:: classref-method + +|void| **bswap32**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +对数组中从偏移量为 ``offset`` 处开始的 ``count`` 个 32 位段落进行字节顺序交换的操作。交换是原地进行的。如果 ``count`` 小于零，则会处理到数组结尾为止，如果处理的数据大小不是 4 的倍数，则处理的最后一个 32 位段落之后的字节不会发生修改。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_bswap64: + +.. rst-class:: classref-method + +|void| **bswap64**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +对数组中从偏移量为 ``offset`` 处开始的 ``count`` 个 64 位段落进行字节顺序交换的操作。交换是原地进行的。如果 ``count`` 小于零，则会处理到数组结尾为止，如果处理的数据大小不是 8 的倍数，则处理的最后一个 64 位段落之后的字节不会发生修改。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_clear: .. rst-class:: classref-method @@ -655,6 +709,18 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 ---- +.. _class_PackedByteArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则不会发生任何事情，返回 ``false``\ 。要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_fill: .. rst-class:: classref-method @@ -685,7 +751,9 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的字节。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的字节。如果 ``index`` 越界或为负数，则该方法失败并返回 ``0``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -703,6 +771,24 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 ---- +.. _class_PackedByteArray_method_get_string_from_multibyte_char: + +.. rst-class:: classref-method + +:ref:`String` **get_string_from_multibyte_char**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +将使用系统多字节代码页编码的数组转换为 :ref:`String`\ 。如果转换失败，则会返回空字符串。这是 :ref:`String.to_multibyte_char_buffer()` 的逆运算。 + +\ ``encoding`` 的有效值由系统决定。如果 ``encoding`` 为空字符串，则会使用系统默认的编码。 + +- 对于 Windows，见\ `代码页标识符 `__ .NET 名称。 + +- 对于 macOS 和 Linux/BSD，支持的编码列表见 ``libiconv`` 库文档及 ``iconv --list``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_get_string_from_utf8: .. rst-class:: classref-method @@ -721,7 +807,7 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 :ref:`String` **get_string_from_utf16**\ (\ ) |const| :ref:`🔗` -将 UTF-16 编码的数组转换为 :ref:`String`\ 。如果缺少 BOM，则假定为系统字节序。如果源数组不是有效的 UTF-16 字符串，则返回空字符串。这是 :ref:`String.to_utf16_buffer()` 的逆运算。 +将 UTF-16 编码的数组转换为 :ref:`String`\ 。如果缺少 BOM，则假定为小端字节序。如果源数组不是有效的 UTF-16 字符串，则返回空字符串。这是 :ref:`String.to_utf16_buffer()` 的逆运算。 .. rst-class:: classref-item-separator @@ -733,7 +819,7 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 :ref:`String` **get_string_from_utf32**\ (\ ) |const| :ref:`🔗` -将 UTF-32 编码的数组转换为 :ref:`String`\ 。假定为系统字节序。如果源数组不是有效的 UTF-32 字符串，则返回空字符串。这是 :ref:`String.to_utf32_buffer()` 的逆运算。 +将 UTF-32 编码的数组转换为 :ref:`String`\ 。如果源数组不是有效的 UTF-32 字符串则返回空字符串。这是 :ref:`String.to_utf32_buffer()` 的逆运算。 .. rst-class:: classref-item-separator @@ -856,7 +942,9 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -938,6 +1026,20 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 ---- +.. _class_PackedByteArray_method_to_color_array: + +.. rst-class:: classref-method + +:ref:`PackedColorArray` **to_color_array**\ (\ ) |const| :ref:`🔗` + +返回数据副本转换得到的 :ref:`PackedColorArray`\ ，会将每 16 个字节的数据块会转换为一个 :ref:`Color` 变体。 + +\ **注意：**\ 输入数组的大小必须为 16（四个 32 位 float 变量的大小）的倍数。新数组的大小是 ``byte_array.size() / 16``\ 。如果原数据无法转换为 :ref:`Color` 变体，则最终的数据未定义。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_to_float32_array: .. rst-class:: classref-method @@ -998,6 +1100,48 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 如果原始数据无法转换为 64 位有符号整数，则最终的数据未定义。 +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_to_vector2_array: + +.. rst-class:: classref-method + +:ref:`PackedVector2Array` **to_vector2_array**\ (\ ) |const| :ref:`🔗` + +返回数据副本转换得到的 :ref:`PackedVector2Array`\ ，会将每 8 个字节（32 位）或每 16 个字节（64 位）的数据块会转换为一个 :ref:`Vector2` 变体。 + +\ **注意：**\ 输入数组的大小必须为 8 或 16（取决于构建设置，详见 :ref:`Vector2`\ ）的倍数。新数组的大小是 ``byte_array.size() / (8 或 16)``\ 。如果原数据无法转换为 :ref:`Vector2` 变体，则最终的数据未定义。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_to_vector3_array: + +.. rst-class:: classref-method + +:ref:`PackedVector3Array` **to_vector3_array**\ (\ ) |const| :ref:`🔗` + +返回数据副本转换得到的 :ref:`PackedVector3Array`\ ，会将每 12 个字节（32 位）或每 24 个字节（64 位）的数据块会转换为一个 :ref:`Vector3` 变体。 + +\ **注意：**\ 输入数组的大小必须为 12 或 24（取决于构建设置，详见 :ref:`Vector3`\ ）的倍数。新数组的大小是 ``byte_array.size() / (12 或 24)``\ 。如果原数据无法转换为 :ref:`Vector3` 变体，则最终的数据未定义。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_to_vector4_array: + +.. rst-class:: classref-method + +:ref:`PackedVector4Array` **to_vector4_array**\ (\ ) |const| :ref:`🔗` + +返回数据副本转换得到的 :ref:`PackedVector4Array`\ ，会将每 16 个字节（32 位）或每 32 个字节（64 位）的数据块会转换为一个 :ref:`Vector4` 变体。 + +\ **注意：**\ 输入数组的大小必须为 16 或 32（取决于构建设置，详见 :ref:`Vector4`\ ）的倍数。新数组的大小是 ``byte_array.size() / (16 或 32)``\ 。如果原数据无法转换为 :ref:`Vector4` 变体，则最终的数据未定义。 + .. rst-class:: classref-section-separator ---- @@ -1054,6 +1198,7 @@ GZIP 的最大压缩率为 1032:1，这意味着较小的压缩后负载很有 请注意，返回的字节是 64 位 :ref:`int`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedcolorarray.rst b/classes/zh_CN/class_packedcolorarray.rst index fbe91c69d7..ed4fc68acc 100644 --- a/classes/zh_CN/class_packedcolorarray.rst +++ b/classes/zh_CN/class_packedcolorarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedColorArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedColorArray.xml. .. _class_PackedColorArray: @@ -19,9 +19,9 @@ PackedColorArray 专门设计用于保存 :ref:`Color` 的数组。紧密打包数据，因此可为大型数组节省内存。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedColorArray** 与 ``Array[Color]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedColorArray** 与 ``Array[Color]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法的情况并\ *非*\ 如此。这些返回的紧缩数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -64,6 +64,8 @@ PackedColorArray +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`Color`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| | @@ -241,6 +243,18 @@ PackedColorArray ---- +.. _class_PackedColorArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Color`\ ) :ref:`🔗` + +在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则不会发生任何事情，返回 ``false``\ 。要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedColorArray_method_fill: .. rst-class:: classref-method @@ -271,7 +285,9 @@ PackedColorArray :ref:`Color` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 :ref:`Color`\ 。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 :ref:`Color`\ 。如果 ``index`` 越界或为负数，则该方法失败并返回 ``Color(0, 0, 0, 1)``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -343,7 +359,9 @@ PackedColorArray :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -487,6 +505,7 @@ PackedColorArray 返回索引 ``index`` 处的\ :ref:`Color`\ 。负数索引可以从末端开始访问元素。使用超出数组范围的索引将导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packeddatacontainer.rst b/classes/zh_CN/class_packeddatacontainer.rst index 58836e0eaa..3942c23548 100644 --- a/classes/zh_CN/class_packeddatacontainer.rst +++ b/classes/zh_CN/class_packeddatacontainer.rst @@ -2,14 +2,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedDataContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedDataContainer.xml. .. _class_PackedDataContainer: PackedDataContainer =================== +**已弃用：** Use :ref:`@GlobalScope.var_to_bytes()` or :ref:`FileAccess.store_var()` instead. To enable data compression, use :ref:`PackedByteArray.compress()` or :ref:`FileAccess.open_compressed()`. + **继承：** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` 将 :ref:`Array` 或 :ref:`Dictionary` 进行高效打包和序列化。 @@ -92,6 +94,7 @@ PackedDataContainer 返回打包后容器的大小（见 :ref:`Array.size()` 和 :ref:`Dictionary.size()`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packeddatacontainerref.rst b/classes/zh_CN/class_packeddatacontainerref.rst index 192a432d0e..c34e04efa2 100644 --- a/classes/zh_CN/class_packeddatacontainerref.rst +++ b/classes/zh_CN/class_packeddatacontainerref.rst @@ -2,14 +2,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedDataContainerRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedDataContainerRef.xml. .. _class_PackedDataContainerRef: PackedDataContainerRef ====================== +**已弃用：** Use :ref:`@GlobalScope.var_to_bytes()` or :ref:`FileAccess.store_var()` instead. To enable data compression, use :ref:`PackedByteArray.compress()` or :ref:`FileAccess.open_compressed()`. + **继承：** :ref:`RefCounted` **<** :ref:`Object` :ref:`PackedDataContainer` 使用的内部类，用于打包嵌套的数组和字典。 @@ -25,7 +27,7 @@ PackedDataContainerRef var packed = PackedDataContainer.new() packed.pack([1, 2, 3, ["nested1", "nested2"], 4, 5, 6]) - + for element in packed: if element is PackedDataContainerRef: for subelement in element: @@ -76,6 +78,7 @@ PackedDataContainerRef 返回打包后容器的大小（见 :ref:`Array.size()` 和 :ref:`Dictionary.size()`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedfloat32array.rst b/classes/zh_CN/class_packedfloat32array.rst index 184b6246a8..3755685790 100644 --- a/classes/zh_CN/class_packedfloat32array.rst +++ b/classes/zh_CN/class_packedfloat32array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedFloat32Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedFloat32Array.xml. .. _class_PackedFloat32Array: @@ -19,9 +19,9 @@ PackedFloat32Array 专门设计用于保存 32 位浮点值（float）的数组。紧密打包数据，因此可为大型数组节省内存。 -如果需要紧密打包 64 位浮点数，请参阅 :ref:`PackedFloat64Array`\ 。 +如果需要紧密打包 64 位浮点数，见 :ref:`PackedFloat64Array`\ 。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。这些返回的紧缩数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -64,6 +64,8 @@ PackedFloat32Array +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | @@ -239,6 +241,20 @@ PackedFloat32Array ---- +.. _class_PackedFloat32Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`float`\ ) :ref:`🔗` + +移除数组中第一次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则什么都不会发生并返回 ``false``\ 。如果要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +\ **注意：**\ :ref:`@GDScript.NAN` 的行为与其它数字不同。因此存在 NaN 时该方法的结果可能不精确。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedFloat32Array_method_fill: .. rst-class:: classref-method @@ -271,7 +287,9 @@ PackedFloat32Array :ref:`float` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 32 位浮点数。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 32 位浮点数。如果 ``index`` 越界或为负数，则该方法失败并返回 ``0.0``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -345,7 +363,9 @@ PackedFloat32Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -497,6 +517,7 @@ PackedFloat32Array 请注意，\ :ref:`float` 类型是 64 位的，这与存储在数组中的值不同。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedfloat64array.rst b/classes/zh_CN/class_packedfloat64array.rst index c0116552a8..e81adcce51 100644 --- a/classes/zh_CN/class_packedfloat64array.rst +++ b/classes/zh_CN/class_packedfloat64array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedFloat64Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedFloat64Array.xml. .. _class_PackedFloat64Array: @@ -21,9 +21,9 @@ PackedFloat64Array 如果只需要紧密打包 32 位浮点数，请参阅 :ref:`PackedFloat32Array` 以获得更节省内存的替代方案。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedFloat64Array** 与 ``Array[float]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedFloat64Array** 与 ``Array[float]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。这些返回的紧缩数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -66,6 +66,8 @@ PackedFloat64Array +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | @@ -241,6 +243,20 @@ PackedFloat64Array ---- +.. _class_PackedFloat64Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`float`\ ) :ref:`🔗` + +移除数组中第一次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则什么都不会发生并返回 ``false``\ 。如果要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +\ **注意：**\ :ref:`@GDScript.NAN` 的行为与其它数字不同。因此存在 NaN 时该方法的结果可能不精确。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedFloat64Array_method_fill: .. rst-class:: classref-method @@ -273,7 +289,9 @@ PackedFloat64Array :ref:`float` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 64 位浮点数。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 64 位浮点数。如果 ``index`` 越界或为负数，则该方法失败并返回 ``0.0``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -347,7 +365,9 @@ PackedFloat64Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -497,6 +517,7 @@ PackedFloat64Array 返回索引 ``index`` 处的 :ref:`float`\ 。负数索引可以从末尾开始访问元素。使用超出数组范围的索引会导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedint32array.rst b/classes/zh_CN/class_packedint32array.rst index 3b707928a8..02afb7ef9f 100644 --- a/classes/zh_CN/class_packedint32array.rst +++ b/classes/zh_CN/class_packedint32array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedInt32Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedInt32Array.xml. .. _class_PackedInt32Array: @@ -21,7 +21,7 @@ PackedInt32Array \ **注意：**\ 该类型存储的是 32 位有符号整数，也就是说它可以取区间 ``[-2^31, 2^31 - 1]`` 内的值，即 ``[-2147483648, 2147483647]``\ 。超过界限时会从另一端绕回。相比之下，\ :ref:`int` 使用带符号的 64 位整数，可以容纳更大的值。紧密存放 64 位整数见 :ref:`PackedInt64Array`\ 。 -\ **注意：**\ 紧缩数组始终按引用传递。如果需要获取数组的副本，独立于原始数组进行修改，请使用 :ref:`duplicate()`\ 。内置属性及方法\ *无需考虑*\ 该规则，返回的紧缩数组是副本，对其进行修改\ *不影响*\ 原值。更新内置属性时，请在修改返回的数组后，将其赋值回该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -64,6 +64,8 @@ PackedInt32Array +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | @@ -235,6 +237,18 @@ PackedInt32Array ---- +.. _class_PackedInt32Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则不会发生任何事情，返回 ``false``\ 。要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedInt32Array_method_fill: .. rst-class:: classref-method @@ -265,7 +279,9 @@ PackedInt32Array :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 32 位整数。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 32 位整数。如果 ``index`` 越界或为负数，则该方法失败并返回 ``0``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -337,7 +353,9 @@ PackedInt32Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -485,6 +503,7 @@ PackedInt32Array 注意，\ :ref:`int` 类型为 64 位，与该数组中所存储的值不同。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedint64array.rst b/classes/zh_CN/class_packedint64array.rst index 1932b3f793..1a09f38822 100644 --- a/classes/zh_CN/class_packedint64array.rst +++ b/classes/zh_CN/class_packedint64array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedInt64Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedInt64Array.xml. .. _class_PackedInt64Array: @@ -21,9 +21,9 @@ PackedInt64Array \ **注意：**\ 该类型存储有符号的 64 位整数，这意味着它可以在区间 ``[-2^63, 2^63 - 1]`` 内取值，即 ``[-9223372036854775808, 9223372036854775807]``\ 。超出这些界限将出现回绕。如果只需要紧密打包 32 位整数，请参阅 :ref:`PackedInt32Array` 以获得更节省内存的替代方案。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedInt64Array** 与 ``Array[int]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便利方法，例如 :ref:`Array.map()`\ 。反过来，类型化数组的迭代和修改速度比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedInt64Array** 与 ``Array[int]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。这些返回的紧缩数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -66,6 +66,8 @@ PackedInt64Array +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | @@ -237,6 +239,18 @@ PackedInt64Array ---- +.. _class_PackedInt64Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则不会发生任何事情，返回 ``false``\ 。要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedInt64Array_method_fill: .. rst-class:: classref-method @@ -267,7 +281,9 @@ PackedInt64Array :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 64 位整数。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 64 位整数。如果 ``index`` 越界或为负数，则该方法失败并返回 ``0``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -339,7 +355,9 @@ PackedInt64Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -485,6 +503,7 @@ PackedInt64Array 返回索引 ``index`` 处的 :ref:`int`\ 。负数索引可以用来从末尾开始访问元素。使用越界的数组索引会产生错误。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedscene.rst b/classes/zh_CN/class_packedscene.rst index feb2aa9d49..6d2155cc07 100644 --- a/classes/zh_CN/class_packedscene.rst +++ b/classes/zh_CN/class_packedscene.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedScene.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedScene.xml. .. _class_PackedScene: @@ -57,15 +57,15 @@ PackedScene var node = Node2D.new() var body = RigidBody2D.new() var collision = CollisionShape2D.new() - + # 创建对象架构。 body.add_child(collision) node.add_child(body) - + # 修改 `body` 的拥有者，但不修改 `collision` 的拥有者。 body.owner = node var scene = PackedScene.new() - + # 只会打包 `node` 和 `body`。 var result = scene.pack(node) if result == OK: @@ -79,15 +79,15 @@ PackedScene var node = new Node2D(); var body = new RigidBody2D(); var collision = new CollisionShape2D(); - + // 创建对象架构。 body.AddChild(collision); node.AddChild(body); - + // 修改 `body` 的拥有者，但不修改 `collision` 的拥有者。 body.Owner = node; var scene = new PackedScene(); - + // 只会打包 `node` 和 `body`。 Error result = scene.Pack(node); if (result == Error.Ok) @@ -233,6 +233,7 @@ enum **GenEditState**: :ref:`🔗` 将 ``path`` 节点及其所有子节点打包到该 **PackedScene** 中。所有现有数据都将被清除。请参阅 :ref:`Node.owner`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedstringarray.rst b/classes/zh_CN/class_packedstringarray.rst index a2c5e57f55..146a7f5bd5 100644 --- a/classes/zh_CN/class_packedstringarray.rst +++ b/classes/zh_CN/class_packedstringarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedStringArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedStringArray.xml. .. _class_PackedStringArray: @@ -27,9 +27,9 @@ PackedStringArray var string = " ".join(string_array) print(string) # "hello world" -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedStringArray** 与 ``Array[String]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedStringArray** 与 ``Array[String]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。这些返回的紧缩数组是副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -79,6 +79,8 @@ PackedStringArray +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`duplicate`\ (\ ) | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`String`\ ) | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | @@ -250,6 +252,18 @@ PackedStringArray ---- +.. _class_PackedStringArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`String`\ ) :ref:`🔗` + +在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则不会发生任何事情，返回 ``false``\ 。要按照索引移除元素，请改用 :ref:`remove_at()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedStringArray_method_fill: .. rst-class:: classref-method @@ -280,7 +294,9 @@ PackedStringArray :ref:`String` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 :ref:`String`\ 。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 :ref:`String`\ 。如果访问越界则返回空字符串并打印错误。不支持负数索引；使用负数索引始终越界，会返回空字符串。 + +该方法类似于 ``[]`` 运算符（\ ``array[index]``\ ），但运算符支持负数索引，越界访问时会造成调试器中断。 .. rst-class:: classref-item-separator @@ -352,7 +368,9 @@ PackedStringArray :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -496,6 +514,7 @@ PackedStringArray 返回索引为 ``index`` 的 :ref:`String`\ 。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedvector2array.rst b/classes/zh_CN/class_packedvector2array.rst index 91ebc35cc4..b8da30cb74 100644 --- a/classes/zh_CN/class_packedvector2array.rst +++ b/classes/zh_CN/class_packedvector2array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedVector2Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector2Array.xml. .. _class_PackedVector2Array: @@ -19,9 +19,9 @@ PackedVector2Array 专门设计用于保存 :ref:`Vector2` 的数组。紧密打包数据，因此可为大型数组节省内存。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector2Array** 与 ``Array[Vector2]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector2Array** 与 ``Array[Vector2]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。返回的紧缩数组是这些的副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -71,6 +71,8 @@ PackedVector2Array +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`Vector2`\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| | @@ -254,6 +256,20 @@ PackedVector2Array ---- +.. _class_PackedVector2Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector2`\ ) :ref:`🔗` + +从数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则什么都不会发生，返回 ``false``\ 。要根据索引来移除元素，请改用 :ref:`remove_at()`\ 。 + +\ **注意：**\ 包含 :ref:`@GDScript.NAN` 元素的向量的行为与其他向量不同。因此，如果包含 NaN，则这个方法的结果可能不准确。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector2Array_method_fill: .. rst-class:: classref-method @@ -286,7 +302,9 @@ PackedVector2Array :ref:`Vector2` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 :ref:`Vector2`\ 。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 :ref:`Vector2`\ 。如果 ``index`` 越界或为负数，则该方法失败并返回 ``Vector2(0, 0)``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -360,7 +378,9 @@ PackedVector2Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -524,6 +544,7 @@ PackedVector2Array 返回索引为 ``index`` 的 :ref:`Vector2`\ 。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedvector3array.rst b/classes/zh_CN/class_packedvector3array.rst index 22dbdacb57..f278e9ab6c 100644 --- a/classes/zh_CN/class_packedvector3array.rst +++ b/classes/zh_CN/class_packedvector3array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedVector3Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector3Array.xml. .. _class_PackedVector3Array: @@ -19,9 +19,9 @@ PackedVector3Array 专门设计用于保存 :ref:`Vector3` 的数组。紧密打包数据，因此可为大型数组节省内存。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector3Array** 与 ``Array[Vector3]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector3Array** 与 ``Array[Vector3]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。返回的紧缩数组是这些的副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -64,6 +64,8 @@ PackedVector3Array +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`Vector3`\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| | @@ -247,6 +249,20 @@ PackedVector3Array ---- +.. _class_PackedVector3Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` + +从数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则什么都不会发生，返回 ``false``\ 。要根据索引来移除元素，请改用 :ref:`remove_at()`\ 。 + +\ **注意：**\ 包含 :ref:`@GDScript.NAN` 元素的向量的行为与其他向量不同。因此，如果包含 NaN，则这个方法的结果可能不准确。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector3Array_method_fill: .. rst-class:: classref-method @@ -279,7 +295,9 @@ PackedVector3Array :ref:`Vector3` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 :ref:`Vector3`\ 。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 :ref:`Vector3`\ 。如果 ``index`` 越界或为负数，则该方法失败并返回 ``Vector3(0, 0, 0)``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -353,7 +371,9 @@ PackedVector3Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 并分配新值比逐个添加新元素要快。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -517,6 +537,7 @@ PackedVector3Array 返回索引为 ``index`` 的 :ref:`Vector3`\ 。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packedvector4array.rst b/classes/zh_CN/class_packedvector4array.rst index cfdf182bc4..ca830fafa2 100644 --- a/classes/zh_CN/class_packedvector4array.rst +++ b/classes/zh_CN/class_packedvector4array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PackedVector4Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector4Array.xml. .. _class_PackedVector4Array: @@ -19,9 +19,9 @@ PackedVector4Array 专门设计用于保存 :ref:`Vector2` 的数组。紧密打包数据，因此可为大型数组节省内存。 -\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector4Array** 与 ``Array[Vector4]``\ ）。此外，紧缩数组消耗的内存更少。缺点是，紧缩数组不太灵活，因为它们不提供许多便捷方法，例如 :ref:`Array.map()`\ 。类型化数组的迭代和修改速度反过来比非类型化数组更快。 +\ **紧缩数组、类型化数组和非类型化数组之间的差异：**\ 与同类型的类型化数组相比，紧缩数组的迭代和修改速度通常更快（例如 **PackedVector4Array** 与 ``Array[Vector4]``\ ）。此外，紧缩数组消耗的内存更少。缺点是紧缩数组不太灵活，因为它们不提供类似 :ref:`Array.map()` 的许多便捷方法。不过类型化数组的迭代和修改速度比非类型化数组更快。 -\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法并\ *非*\ 如此。返回的紧缩数组是这些的副本，更改它\ *不*\ 会影响原始值。要更新内置属性，需要修改返回的数组，然后再次将其分配给该属性。 +\ **注意：**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本，请使用 :ref:`duplicate()`\ 。内置属性和方法\ *并非*\ 如此，它们返回的是紧缩数组的副本，对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组，然后将其重新赋值给该属性。 .. note:: @@ -64,6 +64,8 @@ PackedVector4Array +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector4Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fill`\ (\ value\: :ref:`Vector4`\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| | @@ -245,6 +247,20 @@ PackedVector4Array ---- +.. _class_PackedVector4Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector4`\ ) :ref:`🔗` + +从数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值，则什么都不会发生，返回 ``false``\ 。要根据索引来移除元素，请改用 :ref:`remove_at()`\ 。 + +\ **注意：**\ 包含 :ref:`@GDScript.NAN` 元素的向量的行为与其他向量不同。因此，如果包含 NaN，则这个方法的结果可能不准确。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector4Array_method_fill: .. rst-class:: classref-method @@ -277,7 +293,9 @@ PackedVector4Array :ref:`Vector4` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -返回数组中位于给定索引 ``index`` 处的 :ref:`Vector4`\ 。与使用 ``[]`` 运算符相同（\ ``array[index]``\ ）。 +返回数组中索引为 ``index`` 的 :ref:`Vector4`\ 。如果 ``index`` 越界或为负数，则该方法失败并返回 ``Vector4(0, 0, 0, 0)``\ 。 + +该方法类似于 ``[]`` 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。 .. rst-class:: classref-item-separator @@ -351,7 +369,9 @@ PackedVector4Array :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -设置数组的大小。如果数组被增大，则保留数组末端的元素。如果数组被缩小，则将数组截断到新的大小。 +设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 :ref:`resize()` 然后赋值比逐个添加新元素要快。 + +成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回下列 :ref:`Error` 常量：大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER`\ ，分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY`\ 。请使用 :ref:`size()` 获取调整后的实际大小。 .. rst-class:: classref-item-separator @@ -499,6 +519,7 @@ PackedVector4Array 返回索引为 ``index`` 的 :ref:`Vector4`\ 。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packetpeer.rst b/classes/zh_CN/class_packetpeer.rst index 28ffc7e61c..922128241e 100644 --- a/classes/zh_CN/class_packetpeer.rst +++ b/classes/zh_CN/class_packetpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PacketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeer.xml. .. _class_PacketPeer: @@ -167,6 +167,7 @@ PacketPeer 是基于数据包的协议（如 UDP）的抽象和基类。它提 在内部，这使用与 :ref:`@GlobalScope.var_to_bytes()` 方法相同的编码机制。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packetpeerdtls.rst b/classes/zh_CN/class_packetpeerdtls.rst index f357bd39cd..239f4a9e2f 100644 --- a/classes/zh_CN/class_packetpeerdtls.rst +++ b/classes/zh_CN/class_packetpeerdtls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PacketPeerDTLS.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerDTLS.xml. .. _class_PacketPeerDTLS: @@ -137,7 +137,7 @@ enum **Status**: :ref:`🔗` :ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` -返回连接的状态。取值见 :ref:`Status`\ 。 +返回连接的状态。 .. rst-class:: classref-item-separator @@ -152,6 +152,7 @@ enum **Status**: :ref:`🔗` 轮询连接以检查传入的数据包。经常调用此选项以更新状态并保持连接正常工作。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packetpeerextension.rst b/classes/zh_CN/class_packetpeerextension.rst index f204e41bbc..e99d0ea265 100644 --- a/classes/zh_CN/class_packetpeerextension.rst +++ b/classes/zh_CN/class_packetpeerextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PacketPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerExtension.xml. .. _class_PacketPeerExtension: @@ -25,9 +25,9 @@ PacketPeerExtension :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |required| |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |required| |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ PacketPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -61,7 +61,7 @@ PacketPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -96,6 +96,7 @@ PacketPeerExtension 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packetpeerstream.rst b/classes/zh_CN/class_packetpeerstream.rst index 14f122587b..be247421d4 100644 --- a/classes/zh_CN/class_packetpeerstream.rst +++ b/classes/zh_CN/class_packetpeerstream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PacketPeerStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerStream.xml. .. _class_PacketPeerStream: @@ -100,6 +100,7 @@ PacketStreamPeer 提供了一个在流中使用数据包的包装器。这样就 被包装的 :ref:`StreamPeer` 对象。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_packetpeerudp.rst b/classes/zh_CN/class_packetpeerudp.rst index b8ab62adf6..40cdcefd79 100644 --- a/classes/zh_CN/class_packetpeerudp.rst +++ b/classes/zh_CN/class_packetpeerudp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PacketPeerUDP.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerUDP.xml. .. _class_PacketPeerUDP: @@ -26,10 +26,10 @@ UDP 数据包对等体。可以用来发送和接收原始 UPD 数据包和 :ref :: var peer = PacketPeerUDP.new() - + # 可以自行选择用于发送数据包的本地端口。 peer.bind(4444) - + peer.set_dest_address("1.1.1.1", 4433) peer.put_packet("hello".to_utf8_buffer()) @@ -38,12 +38,12 @@ UDP 数据包对等体。可以用来发送和接收原始 UPD 数据包和 :ref :: var peer - + func _ready(): peer = PacketPeerUDP.new() peer.bind(4433) - - + + func _process(_delta): if peer.get_available_packet_count() > 0: var array_bytes = peer.get_packet() @@ -276,7 +276,7 @@ UDP 数据包对等体。可以用来发送和接收原始 UPD 数据包和 :ref # 服务器 socket.set_dest_address("127.0.0.1", 789) socket.put_packet("Time to stop".to_ascii_buffer()) - + # 客户端 while socket.wait() == OK: var data = socket.get_packet().get_string_from_ascii() @@ -289,7 +289,7 @@ UDP 数据包对等体。可以用来发送和接收原始 UPD 数据包和 :ref // 服务器 socket.SetDestAddress("127.0.0.1", 789); socket.PutPacket("Time to stop".ToAsciiBuffer()); - + // 客户端 while (socket.Wait() == OK) { @@ -303,6 +303,7 @@ UDP 数据包对等体。可以用来发送和接收原始 UPD 数据包和 :ref .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_panel.rst b/classes/zh_CN/class_panel.rst index 1b37c5403f..ed70bc3b34 100644 --- a/classes/zh_CN/class_panel.rst +++ b/classes/zh_CN/class_panel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Panel.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Panel.xml. .. _class_Panel: @@ -60,6 +60,7 @@ Panel 该控件的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_panelcontainer.rst b/classes/zh_CN/class_panelcontainer.rst index 7c622f1e9c..dd74e40523 100644 --- a/classes/zh_CN/class_panelcontainer.rst +++ b/classes/zh_CN/class_panelcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PanelContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PanelContainer.xml. .. _class_PanelContainer: @@ -74,6 +74,7 @@ PanelContainer **PanelContainer** 的背景样式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_panoramaskymaterial.rst b/classes/zh_CN/class_panoramaskymaterial.rst index b7ad125898..8f35223348 100644 --- a/classes/zh_CN/class_panoramaskymaterial.rst +++ b/classes/zh_CN/class_panoramaskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PanoramaSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PanoramaSkyMaterial.xml. .. _class_PanoramaSkyMaterial: @@ -98,6 +98,7 @@ PanoramaSkyMaterial 应用于该 **PanoramaSkyMaterial** 的 :ref:`Texture2D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_parallax2d.rst b/classes/zh_CN/class_parallax2d.rst index 8c550a85ab..97b83d5b43 100644 --- a/classes/zh_CN/class_parallax2d.rst +++ b/classes/zh_CN/class_parallax2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Parallax2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Parallax2D.xml. .. _class_Parallax2D: @@ -45,9 +45,9 @@ Parallax2D +---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ignore_camera_scroll` | ``false`` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`limit_begin` | ``Vector2(-1e+07, -1e+07)`` | + | :ref:`Vector2` | :ref:`limit_begin` | ``Vector2(-10000000, -10000000)`` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`limit_end` | ``Vector2(1e+07, 1e+07)`` | + | :ref:`Vector2` | :ref:`limit_end` | ``Vector2(10000000, 10000000)`` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | +---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -126,7 +126,7 @@ Parallax2D .. rst-class:: classref-property -:ref:`Vector2` **limit_begin** = ``Vector2(-1e+07, -1e+07)`` :ref:`🔗` +:ref:`Vector2` **limit_begin** = ``Vector2(-10000000, -10000000)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -143,7 +143,7 @@ Parallax2D .. rst-class:: classref-property -:ref:`Vector2` **limit_end** = ``Vector2(1e+07, 1e+07)`` :ref:`🔗` +:ref:`Vector2` **limit_end** = ``Vector2(10000000, 10000000)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,6 +242,7 @@ Parallax2D 例如，\ ``1`` 的值表示滚动速度与相机相同。大于 ``1`` 的值表示滚动速度更快，使物体看起来更近。小于 ``1`` 的值表示滚动速度更慢，使物体看起来更远，而 ``0`` 的值表示物体完全停止。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_parallaxbackground.rst b/classes/zh_CN/class_parallaxbackground.rst index 4257313ccf..8eef895d28 100644 --- a/classes/zh_CN/class_parallaxbackground.rst +++ b/classes/zh_CN/class_parallaxbackground.rst @@ -2,14 +2,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ParallaxBackground.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParallaxBackground.xml. .. _class_ParallaxBackground: ParallaxBackground ================== +**已弃用：** Use the :ref:`Parallax2D` node instead. + **继承：** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` 用于创建视差滚动背景的节点。 @@ -155,6 +157,7 @@ ParallaxBackground 使用一个或多个 :ref:`ParallaxLayer` 时会自动计算，但也可用于手动管理无相机时的滚动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_parallaxlayer.rst b/classes/zh_CN/class_parallaxlayer.rst index b71a330459..8586dde282 100644 --- a/classes/zh_CN/class_parallaxlayer.rst +++ b/classes/zh_CN/class_parallaxlayer.rst @@ -2,14 +2,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ParallaxLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParallaxLayer.xml. .. _class_ParallaxLayer: ParallaxLayer ============= +**已弃用：** Use the :ref:`Parallax2D` node instead. + **继承：** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` 使用 :ref:`ParallaxBackground` 的视差滚动层。 @@ -106,6 +108,7 @@ ParallaxLayer 必须是 :ref:`ParallaxBackground` 节 复制视差图层的运动。如果一个轴被设置为 ``0``\ ，它将不会滚动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_particleprocessmaterial.rst b/classes/zh_CN/class_particleprocessmaterial.rst index e5e3d1d33e..7ae19006ee 100644 --- a/classes/zh_CN/class_particleprocessmaterial.rst +++ b/classes/zh_CN/class_particleprocessmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ParticleProcessMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParticleProcessMaterial.xml. .. _class_ParticleProcessMaterial: @@ -1402,7 +1402,7 @@ enum **CollisionMode**: :ref:`🔗` - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) - :ref:`EmissionShape` **get_emission_shape**\ (\ ) -粒子将在这个区域内发射。使用\ :ref:`EmissionShape`\ 常量作为值。 +粒子将在该区域内发射。 .. rst-class:: classref-item-separator @@ -2463,7 +2463,7 @@ enum **CollisionMode**: :ref:`🔗` :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` -如果启用了指定的粒子标志，则返回 ``true``\ 。可选项见 :ref:`ParticleFlags`\ 。 +如果粒子标志 ``particle_flag`` 已启用，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -2525,9 +2525,10 @@ enum **CollisionMode**: :ref:`🔗` |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` -如果为 ``true``\ ，则启用指定的粒子标志。选项见 :ref:`ParticleFlags`\ 。 +将粒子标志 ``particle_flag`` 是否启用设置为 ``enable``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_path2d.rst b/classes/zh_CN/class_path2d.rst index 3cfd591a07..61aa517ba5 100644 --- a/classes/zh_CN/class_path2d.rst +++ b/classes/zh_CN/class_path2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Path2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Path2D.xml. .. _class_Path2D: @@ -58,6 +58,7 @@ Path2D 描述路径的 :ref:`Curve2D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_path3d.rst b/classes/zh_CN/class_path3d.rst index c311688b20..11227f6538 100644 --- a/classes/zh_CN/class_path3d.rst +++ b/classes/zh_CN/class_path3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Path3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Path3D.xml. .. _class_Path3D: @@ -31,9 +31,11 @@ Path3D .. table:: :widths: auto - +-------------------------------+-------------------------------------------+ - | :ref:`Curve3D` | :ref:`curve` | - +-------------------------------+-------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------+-----------------------+ + | :ref:`Curve3D` | :ref:`curve` | | + +-------------------------------+---------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`debug_custom_color` | ``Color(0, 0, 0, 1)`` | + +-------------------------------+---------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -52,6 +54,18 @@ Path3D 当 :ref:`curve` 改变时触发。 +.. rst-class:: classref-item-separator + +---- + +.. _class_Path3D_signal_debug_color_changed: + +.. rst-class:: classref-signal + +**debug_color_changed**\ (\ ) :ref:`🔗` + +当 :ref:`debug_custom_color` 改变时触发。 + .. rst-class:: classref-section-separator ---- @@ -74,7 +88,27 @@ Path3D 描述路径的 :ref:`Curve3D`\ 。 +.. rst-class:: classref-item-separator + +---- + +.. _class_Path3D_property_debug_custom_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug_custom_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_debug_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_custom_color**\ (\ ) + +在编辑器中绘制形状所使用的自定义颜色。 + +如果设为 ``Color(0.0, 0.0, 0.0)``\ （默认值），则会使用“编辑器设置”中设置的颜色。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pathfollow2d.rst b/classes/zh_CN/class_pathfollow2d.rst index 3e9fffbf58..53c2ba7b1b 100644 --- a/classes/zh_CN/class_pathfollow2d.rst +++ b/classes/zh_CN/class_pathfollow2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PathFollow2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PathFollow2D.xml. .. _class_PathFollow2D: @@ -178,6 +178,7 @@ PathFollow2D 节点垂直于曲线的偏移量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pathfollow3d.rst b/classes/zh_CN/class_pathfollow3d.rst index 3bf15585d4..ad99ae730f 100644 --- a/classes/zh_CN/class_pathfollow3d.rst +++ b/classes/zh_CN/class_pathfollow3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PathFollow3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PathFollow3D.xml. .. _class_PathFollow3D: @@ -300,6 +300,7 @@ enum **RotationMode**: :ref:`🔗` 校正 ``transform``\ 。\ ``rotation_mode`` 隐式指定如何计算姿势（向前、向上和侧向）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pckpacker.rst b/classes/zh_CN/class_pckpacker.rst index 22e1f8941d..f3e2111aa1 100644 --- a/classes/zh_CN/class_pckpacker.rst +++ b/classes/zh_CN/class_pckpacker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PCKPacker.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PCKPacker.xml. .. _class_PCKPacker: @@ -77,7 +77,7 @@ PCKPacker :ref:`Error` **add_file**\ (\ target_path\: :ref:`String`, source_path\: :ref:`String`, encrypt\: :ref:`bool` = false\ ) :ref:`🔗` -将 ``source_path`` 文件添加到当前 PCK 包的内部路径 ``target_path`` 处。\ ``target_path`` 不必写 ``res://`` 前缀，内部会将其去除。 +将 ``source_path`` 文件添加到当前 PCK 包的内部路径 ``target_path`` 处。\ ``target_path`` 不必写 ``res://`` 前缀，内部会将其去除。文件内容会立即写入到 PCK 中。 .. rst-class:: classref-item-separator @@ -101,7 +101,9 @@ PCKPacker :ref:`Error` **flush**\ (\ verbose\: :ref:`bool` = false\ ) :ref:`🔗` -自上次刷新以来，使用所有 :ref:`add_file()` 调用写入指定的文件。如果 ``verbose`` 为 ``true``\ ，被添加的文件的列表将被打印到控制台，以便于调试。 +写入文件目录并关闭 PCK。如果 ``verbose`` 为 ``true``\ ，则会将文件列表输出在控制台，方便调试。 + +\ **注意：**\ **PCKPacker** 被释放时会自动刷新，释放发生在离开作用域或被赋值为 ``null`` 时。在 C# 中，使用完后必须弃置该引用，可以使用 ``using`` 语句或直接调用 ``Dispose`` 方法。 .. rst-class:: classref-item-separator @@ -116,6 +118,7 @@ PCKPacker 在文件路径 ``pck_path`` 处新建 PCK 文件。不会自动添加 ``.pck`` 文件扩展名，因此 ``pck_path`` 中应包含该扩展名（即使扩展名不是必需的）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_performance.rst b/classes/zh_CN/class_performance.rst index 2eea8a9a67..76253f0961 100644 --- a/classes/zh_CN/class_performance.rst +++ b/classes/zh_CN/class_performance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Performance.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Performance.xml. .. _class_Performance: @@ -266,7 +266,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_ACTIVE_MAPS** = ``24`` -:ref:`NavigationServer3D` 中活动导航地图的数量。也包含 World2D 和 World3D 所创建的两张默认导航地图。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中活动导航地图的数量。World2D 和 World3D 各自创建的两张默认的空导航地图也算在内。 .. _class_Performance_constant_NAVIGATION_REGION_COUNT: @@ -274,7 +274,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_REGION_COUNT** = ``25`` -:ref:`NavigationServer3D` 中活动导航地区的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中活动导航区块的数量。 .. _class_Performance_constant_NAVIGATION_AGENT_COUNT: @@ -282,7 +282,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_AGENT_COUNT** = ``26`` -:ref:`NavigationServer3D` 中正在处理避障的活动导航代理的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中活动的处理避障的导航代理的数量。 .. _class_Performance_constant_NAVIGATION_LINK_COUNT: @@ -290,7 +290,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_LINK_COUNT** = ``27`` -:ref:`NavigationServer3D` 中活动导航链接的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中活动导航链接的数量。 .. _class_Performance_constant_NAVIGATION_POLYGON_COUNT: @@ -298,7 +298,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_POLYGON_COUNT** = ``28`` -:ref:`NavigationServer3D` 中导航网格多边形的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中导航网格多边形的数量。 .. _class_Performance_constant_NAVIGATION_EDGE_COUNT: @@ -306,7 +306,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_EDGE_COUNT** = ``29`` -:ref:`NavigationServer3D` 中导航网格多边形边缘的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中导航网格多边形边缘的数量。 .. _class_Performance_constant_NAVIGATION_EDGE_MERGE_COUNT: @@ -314,7 +314,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_EDGE_MERGE_COUNT** = ``30`` -:ref:`NavigationServer3D` 中由于边键重叠而被合并的导航网格多边形的边的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中由于边界重叠而被合并的导航网格多边形边缘的数量。 .. _class_Performance_constant_NAVIGATION_EDGE_CONNECTION_COUNT: @@ -322,7 +322,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_EDGE_CONNECTION_COUNT** = ``31`` -:ref:`NavigationServer3D` 中由边缘接近而被认为已连接的多边形的边的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中由于边缘接近而被认为存在连接的多边形边缘的数量。 .. _class_Performance_constant_NAVIGATION_EDGE_FREE_COUNT: @@ -330,7 +330,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_EDGE_FREE_COUNT** = ``32`` -:ref:`NavigationServer3D` 中无法合并的导航网格多边形的边的数量。这些边仍然可以通过边缘接近或使用链接而被连接。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中无法合并的导航网格多边形边缘的数量。这些边仍然可以通过边缘接近或使用链接而被连接。 .. _class_Performance_constant_NAVIGATION_OBSTACLE_COUNT: @@ -338,7 +338,7 @@ enum **Monitor**: :ref:`🔗` :ref:`Monitor` **NAVIGATION_OBSTACLE_COUNT** = ``33`` -:ref:`NavigationServer3D` 中活动导航障碍物的数量。 +:ref:`NavigationServer2D` 和 :ref:`NavigationServer3D` 中活动导航障碍物的数量。 .. _class_Performance_constant_PIPELINE_COMPILATIONS_CANVAS: @@ -380,11 +380,171 @@ enum **Monitor**: :ref:`🔗` 因优化当前场景而触发的管线编译次数。这些编译是在后台进行的，不会导致任何卡顿。 +.. _class_Performance_constant_NAVIGATION_2D_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_ACTIVE_MAPS** = ``39`` + +:ref:`NavigationServer2D` 中活动导航地图的数量。World2D 所创建的两张默认的空导航地图也算在内。 + +.. _class_Performance_constant_NAVIGATION_2D_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_REGION_COUNT** = ``40`` + +:ref:`NavigationServer2D` 中活动导航区块的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_AGENT_COUNT** = ``41`` + +:ref:`NavigationServer2D` 中活动的处理避障的导航代理的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_LINK_COUNT** = ``42`` + +:ref:`NavigationServer2D` 中活动导航链接的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_POLYGON_COUNT** = ``43`` + +:ref:`NavigationServer2D` 中导航网格多边形的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_COUNT** = ``44`` + +:ref:`NavigationServer2D` 中导航网格多边形边缘的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_MERGE_COUNT** = ``45`` + +:ref:`NavigationServer2D` 中由于边界重叠而被合并的导航网格多边形边缘的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_CONNECTION_COUNT** = ``46`` + +:ref:`NavigationServer2D` 中由于边缘接近而被认为存在连接的多边形边缘的数量。 + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_FREE_COUNT** = ``47`` + +:ref:`NavigationServer3D` 中无法合并的导航网格多边形边缘的数量。这些边仍然可以通过边缘接近或使用链接而被连接。 + +.. _class_Performance_constant_NAVIGATION_2D_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_OBSTACLE_COUNT** = ``48`` + +:ref:`NavigationServer2D` 中活动导航障碍物的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_ACTIVE_MAPS** = ``49`` + +:ref:`NavigationServer3D` 中活动导航地图的数量。World3D 所创建的两张默认的空导航地图也算在内。 + +.. _class_Performance_constant_NAVIGATION_3D_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_REGION_COUNT** = ``50`` + +:ref:`NavigationServer3D` 中活动导航地区的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_AGENT_COUNT** = ``51`` + +:ref:`NavigationServer3D` 中正在处理避障的活动导航代理的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_LINK_COUNT** = ``52`` + +:ref:`NavigationServer3D` 中活动导航链接的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_POLYGON_COUNT** = ``53`` + +:ref:`NavigationServer3D` 中导航网格多边形的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_COUNT** = ``54`` + +:ref:`NavigationServer3D` 中导航网格多边形边缘的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_MERGE_COUNT** = ``55`` + +:ref:`NavigationServer3D` 中由于边键重叠而被合并的导航网格多边形的边的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_CONNECTION_COUNT** = ``56`` + +:ref:`NavigationServer3D` 中由边缘接近而被认为已连接的多边形的边的数量。 + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_FREE_COUNT** = ``57`` + +:ref:`NavigationServer3D` 中无法合并的导航网格多边形的边的数量。这些边仍然可以通过边缘接近或使用链接而被连接。 + +.. _class_Performance_constant_NAVIGATION_3D_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_OBSTACLE_COUNT** = ``58`` + +:ref:`NavigationServer3D` 中活动导航障碍物的数量。 + .. _class_Performance_constant_MONITOR_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Monitor` **MONITOR_MAX** = ``39`` +:ref:`Monitor` **MONITOR_MAX** = ``59`` 代表 :ref:`Monitor` 枚举的大小。 @@ -412,21 +572,21 @@ enum **Monitor**: :ref:`🔗` func _ready(): var monitor_value = Callable(self, "get_monitor_value") - + # 将名称为“MyName”的监视器添加到类别“MyCategory”。 Performance.add_custom_monitor("MyCategory/MyMonitor", monitor_value) - + # 将名称为“MyName”的监视器添加到类别“Custom”。 # 注意：“MyCategory/MyMonitor”和“MyMonitor”同名但不同 ID，所以代码有效。 Performance.add_custom_monitor("MyMonitor", monitor_value) - + # 将名称为“MyName”的监视器添加到类别“Custom”。 # 注意：“MyMonitor”和“Custom/MyMonitor”名称相同，类别相同，但 ID 不同，所以代码有效。 Performance.add_custom_monitor("Custom/MyMonitor", monitor_value) - + # 将名称为“MyCategoryOne/MyCategoryTwo/MyMonitor”的监视器添加到类别“Custom”。 Performance.add_custom_monitor("MyCategoryOne/MyCategoryTwo/MyMonitor", monitor_value) - + func get_monitor_value(): return randi() % 25 @@ -435,21 +595,21 @@ enum **Monitor**: :ref:`🔗` public override void _Ready() { var monitorValue = new Callable(this, MethodName.GetMonitorValue); - + // 将名称为“MyName”的监视器添加到类别“MyCategory”。 Performance.AddCustomMonitor("MyCategory/MyMonitor", monitorValue); // 将名称为“MyName”的监视器添加到类别“Custom”。 // 注意：“MyCategory/MyMonitor”和“MyMonitor”同名但不同 ID，所以代码有效。 Performance.AddCustomMonitor("MyMonitor", monitorValue); - + // 将名称为“MyName”的监视器添加到类别“Custom”。 // 注意：“MyMonitor”和“Custom/MyMonitor”名称相同，类别相同，但 ID 不同，所以代码有效。 Performance.AddCustomMonitor("Custom/MyMonitor", monitorValue); - + // 将名称为“MyCategoryOne/MyCategoryTwo/MyMonitor”的监视器添加到类别“Custom”。 Performance.AddCustomMonitor("MyCategoryOne/MyCategoryTwo/MyMonitor", monitorValue); } - + public int GetMonitorValue() { return GD.Randi() % 25; @@ -549,6 +709,7 @@ enum **Monitor**: :ref:`🔗` 移除具有给定 ``id`` 的自定义监视器。如果给定的 ``id`` 已经不存在，则打印一个错误。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicalbone2d.rst b/classes/zh_CN/class_physicalbone2d.rst index 635a1945a5..abcba397fb 100644 --- a/classes/zh_CN/class_physicalbone2d.rst +++ b/classes/zh_CN/class_physicalbone2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicalBone2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBone2D.xml. .. _class_PhysicalBone2D: @@ -184,6 +184,7 @@ PhysicalBone2D 返回一个布尔值，表示 **PhysicalBone2D** 节点是否处于运行状态，正在使用 Godot 2D 物理引擎进行仿真。为 ``true`` 时，该 PhysicalBone2D 节点正在使用物理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicalbone3d.rst b/classes/zh_CN/class_physicalbone3d.rst index 9ad3589666..3487c840bc 100644 --- a/classes/zh_CN/class_physicalbone3d.rst +++ b/classes/zh_CN/class_physicalbone3d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicalBone3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBone3D.xml. .. _class_PhysicalBone3D: @@ -218,7 +218,7 @@ PhysicsBone3D 应用了六自由度关节。 - |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_angular_damp_mode**\ (\ ) -定义如何应用 :ref:`angular_damp`\ 。可能的取值见 :ref:`DampMode`\ 。 +定义如何应用 :ref:`angular_damp`\ 。 .. rst-class:: classref-item-separator @@ -392,7 +392,7 @@ PhysicsBone3D 应用了六自由度关节。 - |void| **set_joint_type**\ (\ value\: :ref:`JointType`\ ) - :ref:`JointType` **get_joint_type**\ (\ ) -设置关节的类型。可能的值见 :ref:`JointType`\ 。 +设置关节类型。 .. rst-class:: classref-item-separator @@ -428,7 +428,7 @@ PhysicsBone3D 应用了六自由度关节。 - |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_linear_damp_mode**\ (\ ) -定义如何应用 :ref:`linear_damp`\ 。有关可能的值，请参阅 :ref:`DampMode`\ 。 +定义如何应用 :ref:`linear_damp`\ 。 .. rst-class:: classref-item-separator @@ -550,6 +550,7 @@ PhysicsBone3D 应用了六自由度关节。 如果 PhysicsBone3D 正在进行物理模拟，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicalbonesimulator3d.rst b/classes/zh_CN/class_physicalbonesimulator3d.rst index 17eedf97b1..9968a5b2ca 100644 --- a/classes/zh_CN/class_physicalbonesimulator3d.rst +++ b/classes/zh_CN/class_physicalbonesimulator3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicalBoneSimulator3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBoneSimulator3D.xml. .. _class_PhysicalBoneSimulator3D: @@ -113,6 +113,7 @@ PhysicalBoneSimulator3D 让 Skeleton 中的 :ref:`PhysicalBone3D` 节点停止仿真模拟。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicalskymaterial.rst b/classes/zh_CN/class_physicalskymaterial.rst index b36ba70bb5..977e6da85c 100644 --- a/classes/zh_CN/class_physicalskymaterial.rst +++ b/classes/zh_CN/class_physicalskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicalSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalSkyMaterial.xml. .. _class_PhysicalSkyMaterial: @@ -248,6 +248,7 @@ PhysicalSkyMaterial 如果为 ``true``\ ，则启用去色带。去色带会增加少量噪点，这有助于减少天空中颜色的平滑变化而出现的色带。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsbody2d.rst b/classes/zh_CN/class_physicsbody2d.rst index edd43f48b6..da59119993 100644 --- a/classes/zh_CN/class_physicsbody2d.rst +++ b/classes/zh_CN/class_physicsbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsBody2D.xml. .. _class_PhysicsBody2D: @@ -30,6 +30,8 @@ PhysicsBody2D - :doc:`物理介绍 <../tutorials/physics/physics_introduction>` +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + .. rst-class:: classref-reftable-group 属性 @@ -158,6 +160,7 @@ PhysicsBody2D 如果 ``recovery_as_collision`` 为 ``true``\ ，恢复阶段的任何穿透也将被报告为碰撞；这对于检查该实体是否会\ *接触*\ 其他任意实体很有用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsbody3d.rst b/classes/zh_CN/class_physicsbody3d.rst index 64d9c5bab7..2e2c14714c 100644 --- a/classes/zh_CN/class_physicsbody3d.rst +++ b/classes/zh_CN/class_physicsbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsBody3D.xml. .. _class_PhysicsBody3D: @@ -32,6 +32,8 @@ PhysicsBody3D - :doc:`物理介绍 <../tutorials/physics/physics_introduction>` +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + .. rst-class:: classref-reftable-group 属性 @@ -309,6 +311,7 @@ PhysicsBody3D \ ``max_collisions`` 允许检索一个以上的碰撞结果。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectbodystate2d.rst b/classes/zh_CN/class_physicsdirectbodystate2d.rst index 45bb580a37..86a016dad6 100644 --- a/classes/zh_CN/class_physicsdirectbodystate2d.rst +++ b/classes/zh_CN/class_physicsdirectbodystate2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectBodyState2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState2D.xml. .. _class_PhysicsDirectBodyState2D: @@ -47,6 +47,10 @@ PhysicsDirectBodyState2D +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`center_of_mass_local` | +---------------------------------------+-------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`collision_layer` | + +---------------------------------------+-------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`collision_mask` | + +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_inertia` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_mass` | @@ -190,6 +194,40 @@ PhysicsDirectBodyState2D ---- +.. _class_PhysicsDirectBodyState2D_property_collision_layer: + +.. rst-class:: classref-property + +:ref:`int` **collision_layer** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) + +The body's collision layer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState2D_property_collision_mask: + +.. rst-class:: classref-property + +:ref:`int` **collision_mask** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) + +The body's collision mask. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState2D_property_inverse_inertia: .. rst-class:: classref-property @@ -707,6 +745,7 @@ PhysicsDirectBodyState2D 见 :ref:`add_constant_torque()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectbodystate2dextension.rst b/classes/zh_CN/class_physicsdirectbodystate2dextension.rst index cd06d028e5..30b883c14d 100644 --- a/classes/zh_CN/class_physicsdirectbodystate2dextension.rst +++ b/classes/zh_CN/class_physicsdirectbodystate2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectBodyState2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState2DExtension.xml. .. _class_PhysicsDirectBodyState2DExtension: @@ -31,95 +31,103 @@ PhysicsDirectBodyState2DExtension .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_constant_force`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_constant_torque`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`_get_space_state`\ (\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_total_gravity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_get_transform`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform2D`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_collision_layer`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_collision_mask`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_constant_force`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_constant_torque`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`_get_space_state`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_total_gravity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_get_transform`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_collision_layer`\ (\ layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_collision_mask`\ (\ mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform2D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,7 +142,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.add_constant_central_force()` 的可覆盖版本。 @@ -146,7 +154,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.add_constant_force()` 的可覆盖版本。 @@ -158,7 +166,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_add_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.add_constant_torque()` 的可覆盖版本。 @@ -170,7 +178,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_apply_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_central_force()` 的可覆盖版本。 @@ -182,7 +190,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_central_impulse()` 的可覆盖版本。 @@ -194,7 +202,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_force()` 的可覆盖版本。 @@ -206,7 +214,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_impulse()` 的可覆盖版本。 @@ -218,7 +226,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_apply_torque**\ (\ torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_torque()` 的可覆盖版本。 @@ -230,7 +238,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.apply_torque_impulse()` 的可覆盖版本。 @@ -242,7 +250,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_angular_velocity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_angular_velocity**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.angular_velocity` 及其对应 getter 的行为。 @@ -254,7 +262,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_center_of_mass**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.center_of_mass` 及其对应 getter 的行为。 @@ -266,7 +274,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass_local**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_center_of_mass_local**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.center_of_mass_local` 及其对应 getter 的行为。 @@ -274,11 +282,39 @@ PhysicsDirectBodyState2DExtension ---- +.. _class_PhysicsDirectBodyState2DExtension_private_method__get_collision_layer: + +.. rst-class:: classref-method + +:ref:`int` **_get_collision_layer**\ (\ ) |virtual| |required| |const| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState2DExtension_private_method__get_collision_mask: + +.. rst-class:: classref-method + +:ref:`int` **_get_collision_mask**\ (\ ) |virtual| |required| |const| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState2DExtension_private_method__get_constant_force: .. rst-class:: classref-method -:ref:`Vector2` **_get_constant_force**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_constant_force**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_constant_force()` 的可覆盖版本。 @@ -290,7 +326,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_constant_torque**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_constant_torque**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_constant_torque()` 的可覆盖版本。 @@ -302,7 +338,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider()` 的可覆盖版本。 @@ -314,7 +350,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider_id()` 的可覆盖版本。 @@ -326,7 +362,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider_object()` 的可覆盖版本。 @@ -338,7 +374,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider_position()` 的可覆盖版本。 @@ -350,7 +386,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider_shape()` 的可覆盖版本。 @@ -362,7 +398,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_collider_velocity_at_position()` 的可覆盖版本。 @@ -374,7 +410,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_count()` 的可覆盖版本。 @@ -386,7 +422,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_impulse()` 的可覆盖版本。 @@ -398,7 +434,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_local_normal()` 的可覆盖版本。 @@ -410,7 +446,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_local_position()` 的可覆盖版本。 @@ -422,7 +458,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_local_shape()` 的可覆盖版本。 @@ -434,7 +470,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_contact_local_velocity_at_position()` 的可覆盖版本。 @@ -446,7 +482,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_inverse_inertia**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_inverse_inertia**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.inverse_inertia` 及其对应 getter 的行为。 @@ -458,7 +494,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.inverse_mass` 及其对应 getter 的行为。 @@ -470,7 +506,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_linear_velocity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_linear_velocity**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.linear_velocity` 及其对应 getter 的行为。 @@ -482,7 +518,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **_get_space_state**\ (\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectSpaceState2D` **_get_space_state**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_space_state()` 的可覆盖版本。 @@ -494,7 +530,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_step**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_step**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.step` 及其对应 getter 的行为。 @@ -506,7 +542,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.total_angular_damp` 及其对应 getter 的行为。 @@ -518,7 +554,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_total_gravity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_total_gravity**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.total_gravity` 及其对应 getter 的行为。 @@ -530,7 +566,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.total_linear_damp` 及其对应 getter 的行为。 @@ -542,7 +578,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Transform2D` **_get_transform**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform2D` **_get_transform**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.transform` 及其对应 getter 的行为。 @@ -554,7 +590,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.get_velocity_at_local_position()` 的可覆盖版本。 @@ -566,7 +602,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ ) |virtual| :ref:`🔗` +|void| **_integrate_forces**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.integrate_forces()` 的可覆盖版本。 @@ -578,7 +614,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |required| |const| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.sleeping` 及其对应 getter 的行为。 @@ -590,7 +626,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_set_angular_velocity**\ (\ velocity\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.angular_velocity` 及其对应 setter 的行为。 @@ -598,11 +634,39 @@ PhysicsDirectBodyState2DExtension ---- +.. _class_PhysicsDirectBodyState2DExtension_private_method__set_collision_layer: + +.. rst-class:: classref-method + +|void| **_set_collision_layer**\ (\ layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState2DExtension_private_method__set_collision_mask: + +.. rst-class:: classref-method + +|void| **_set_collision_mask**\ (\ mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState2DExtension_private_method__set_constant_force: .. rst-class:: classref-method -|void| **_set_constant_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_set_constant_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.set_constant_force()` 的可覆盖版本。 @@ -614,7 +678,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_set_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_set_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsDirectBodyState2D.set_constant_torque()` 的可覆盖版本。 @@ -626,7 +690,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.linear_velocity` 及其对应 setter 的行为。 @@ -638,7 +702,7 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.sleeping` 及其对应 setter 的行为。 @@ -650,11 +714,12 @@ PhysicsDirectBodyState2DExtension .. rst-class:: classref-method -|void| **_set_transform**\ (\ transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` +|void| **_set_transform**\ (\ transform\: :ref:`Transform2D`\ ) |virtual| |required| :ref:`🔗` 实现后能够覆盖 :ref:`PhysicsDirectBodyState2D.transform` 及其对应 setter 的行为。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectbodystate3d.rst b/classes/zh_CN/class_physicsdirectbodystate3d.rst index c2b2c6e543..0efc8e81c0 100644 --- a/classes/zh_CN/class_physicsdirectbodystate3d.rst +++ b/classes/zh_CN/class_physicsdirectbodystate3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectBodyState3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState3D.xml. .. _class_PhysicsDirectBodyState3D: @@ -47,6 +47,10 @@ PhysicsDirectBodyState3D +---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`center_of_mass_local` | +---------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`collision_layer` | + +---------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`collision_mask` | + +---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`inverse_inertia` | +---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`inverse_inertia_tensor` | @@ -194,6 +198,40 @@ PhysicsDirectBodyState3D ---- +.. _class_PhysicsDirectBodyState3D_property_collision_layer: + +.. rst-class:: classref-property + +:ref:`int` **collision_layer** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) + +The body's collision layer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState3D_property_collision_mask: + +.. rst-class:: classref-property + +:ref:`int` **collision_mask** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) + +The body's collision mask. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState3D_property_inverse_inertia: .. rst-class:: classref-property @@ -745,6 +783,7 @@ PhysicsDirectBodyState3D 见 :ref:`add_constant_torque()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectbodystate3dextension.rst b/classes/zh_CN/class_physicsdirectbodystate3dextension.rst index ce659bf1eb..01992f8404 100644 --- a/classes/zh_CN/class_physicsdirectbodystate3dextension.rst +++ b/classes/zh_CN/class_physicsdirectbodystate3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectBodyState3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState3DExtension.xml. .. _class_PhysicsDirectBodyState3DExtension: @@ -31,99 +31,107 @@ PhysicsDirectBodyState3DExtension .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_constant_force`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_constant_torque`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`_get_inverse_inertia_tensor`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`_get_principal_inertia_axes`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`_get_space_state`\ (\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_total_gravity`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_get_transform`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_collision_layer`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_collision_mask`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_constant_force`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_constant_torque`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`_get_inverse_inertia_tensor`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`_get_principal_inertia_axes`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`_get_space_state`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_total_gravity`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_get_transform`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_collision_layer`\ (\ layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_collision_mask`\ (\ mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -138,7 +146,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -152,7 +160,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -166,7 +174,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -180,7 +188,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -194,7 +202,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -208,7 +216,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -222,7 +230,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -236,7 +244,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -250,7 +258,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -264,7 +272,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_angular_velocity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_angular_velocity**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -278,7 +286,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_center_of_mass**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -292,7 +300,35 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass_local**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_center_of_mass_local**\ (\ ) |virtual| |required| |const| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState3DExtension_private_method__get_collision_layer: + +.. rst-class:: classref-method + +:ref:`int` **_get_collision_layer**\ (\ ) |virtual| |required| |const| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState3DExtension_private_method__get_collision_mask: + +.. rst-class:: classref-method + +:ref:`int` **_get_collision_mask**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -306,7 +342,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_force**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_constant_force**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -320,7 +356,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_torque**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_constant_torque**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -334,7 +370,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -348,7 +384,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -362,7 +398,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -376,7 +412,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -390,7 +426,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -404,7 +440,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -418,7 +454,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -432,7 +468,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -446,7 +482,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -460,7 +496,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -474,7 +510,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -488,7 +524,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -502,7 +538,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_inverse_inertia**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_inverse_inertia**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -516,7 +552,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Basis` **_get_inverse_inertia_tensor**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Basis` **_get_inverse_inertia_tensor**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -530,7 +566,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -544,7 +580,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_linear_velocity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_linear_velocity**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -558,7 +594,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Basis` **_get_principal_inertia_axes**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Basis` **_get_principal_inertia_axes**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -572,7 +608,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_get_space_state**\ (\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectSpaceState3D` **_get_space_state**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -586,7 +622,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`float` **_get_step**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_step**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -600,7 +636,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -614,7 +650,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_total_gravity**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_total_gravity**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -628,7 +664,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -642,7 +678,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Transform3D` **_get_transform**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform3D` **_get_transform**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -656,7 +692,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -670,7 +706,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ ) |virtual| :ref:`🔗` +|void| **_integrate_forces**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -684,7 +720,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -698,7 +734,35 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_angular_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState3DExtension_private_method__set_collision_layer: + +.. rst-class:: classref-method + +|void| **_set_collision_layer**\ (\ layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsDirectBodyState3DExtension_private_method__set_collision_mask: + +.. rst-class:: classref-method + +|void| **_set_collision_mask**\ (\ mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -712,7 +776,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_constant_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_constant_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -726,7 +790,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -740,7 +804,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -754,7 +818,7 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -768,13 +832,14 @@ PhysicsDirectBodyState3DExtension .. rst-class:: classref-method -|void| **_set_transform**\ (\ transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_set_transform**\ (\ transform\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectspacestate2d.rst b/classes/zh_CN/class_physicsdirectspacestate2d.rst index f3b5bd7efe..75ea0ff5c6 100644 --- a/classes/zh_CN/class_physicsdirectspacestate2d.rst +++ b/classes/zh_CN/class_physicsdirectspacestate2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectSpaceState2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState2D.xml. .. _class_PhysicsDirectSpaceState2D: @@ -23,6 +23,8 @@ PhysicsDirectSpaceState2D 提供对 :ref:`PhysicsServer2D` 中物理空间的直接访问。主要用于对驻留在给定空间中的对象和区域进行查询。 +\ **注意：**\ 该类不应直接实例化。请使用 :ref:`World2D.direct_space_state` 获取世界的 2D 物理空间状态。 + .. rst-class:: classref-introduction-group 教程 @@ -99,22 +101,22 @@ PhysicsDirectSpaceState2D :ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) :ref:`🔗` -检查通过 :ref:`PhysicsShapeQueryParameters2D` 对象给出的一个形状与该空间的交点。如果它与多个形状碰撞，则选择最近的一个。如果该形状没有与任何对象相交，则返回一个空字典。 - -\ **注意：**\ 该方法不考虑对象的 ``motion`` 属性。返回的对象是一个包含以下字段的字典： +检查通过 :ref:`PhysicsShapeQueryParameters3D` 对象给出的形状与该空间的交点。如果它与多个形状发生碰撞，则选择最近的一个。返回的对象是一个包含以下字段的字典： \ ``collider_id``\ ：该碰撞对象的 ID。 -\ ``linear_velocity``\ ：该碰撞对象的速度 :ref:`Vector2`\ 。如果对象是一个 :ref:`Area2D`\ ，则结果是 ``(0, 0)``\ 。 +\ ``linear_velocity``\ ：该碰撞对象的速度 :ref:`Vector3`\ 。如果对象是一个 :ref:`Area3D`\ ，则结果为 ``(0, 0, 0)``\ 。 \ ``normal``\ ：相交点处查询形状的碰撞法线，法线指向远离相交对象的方向。 \ ``point``\ ：相交点。 -\ ``rid``\ ：相交对象的 :ref:`RID`\ 。 +\ ``rid``\ ：该相交对象的 :ref:`RID`\ 。 \ ``shape``\ ：该碰撞形状的形状索引。 +如果该形状没有与任何东西相交，则返回一个空字典。 + .. rst-class:: classref-item-separator ---- @@ -188,6 +190,7 @@ PhysicsDirectSpaceState2D 可以使用 ``max_results`` 参数限制相交的数量，以减少处理时间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectspacestate2dextension.rst b/classes/zh_CN/class_physicsdirectspacestate2dextension.rst index 3cd120deb6..ad40ce1ce1 100644 --- a/classes/zh_CN/class_physicsdirectspacestate2dextension.rst +++ b/classes/zh_CN/class_physicsdirectspacestate2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectSpaceState2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState2DExtension.xml. .. _class_PhysicsDirectSpaceState2DExtension: @@ -31,21 +31,21 @@ PhysicsDirectSpaceState2DExtension .. table:: :widths: auto - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| |required| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -60,7 +60,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -74,7 +74,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -88,7 +88,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -102,7 +102,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -116,7 +116,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -130,7 +130,7 @@ PhysicsDirectSpaceState2DExtension .. rst-class:: classref-method -:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -151,6 +151,7 @@ PhysicsDirectSpaceState2DExtension 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectspacestate3d.rst b/classes/zh_CN/class_physicsdirectspacestate3d.rst index f3775369c6..46a91986d3 100644 --- a/classes/zh_CN/class_physicsdirectspacestate3d.rst +++ b/classes/zh_CN/class_physicsdirectspacestate3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectSpaceState3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState3D.xml. .. _class_PhysicsDirectSpaceState3D: @@ -23,6 +23,8 @@ PhysicsDirectSpaceState3D 提供对 :ref:`PhysicsServer3D` 中物理空间的直接访问。主要用于对驻留在给定空间中的对象和区域进行查询。 +\ **注意：**\ 该类不应直接实例化。请使用 :ref:`World3D.direct_space_state` 获取世界的 3D 物理空间状态。 + .. rst-class:: classref-introduction-group 教程 @@ -69,11 +71,11 @@ PhysicsDirectSpaceState3D :ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` -检查 :ref:`Shape3D` 在不发生碰撞的情况下可以移动多远。查询的所有参数，包括形状，都通过 :ref:`PhysicsShapeQueryParameters3D` 对象提供。 +检查 :ref:`Shape3D` 能够在不发生碰撞的情况下移动多远。包括形状和运动在内的所有查询参数都通过 :ref:`PhysicsShapeQueryParameters3D` 对象提供。 -返回一个数组，其中包含运动的安全和不安全比例（介于 0 和 1 之间）。安全比例是在不发生碰撞的情况下可以进行的运动的最大分数。不安全比例是发生碰撞必须移动的距离的最小分数。如果没有检测到碰撞，将返回 ``[1.0, 1.0]`` 的结果。 +返回包含该运动的安全和不安全比例（在 0 和 1 之间）的数组。安全比例是该运动能够不发生碰撞的最大分数。不安全比例是发生碰撞所需的最小分数。如果没有检测到碰撞，则返回的结果为 ``[1.0, 1.0]``\ 。 -\ **注意：**\ 该形状已经与之发生碰撞的任何 :ref:`Shape3D`\ ，例如在内部的，将被忽略。使用 :ref:`collide_shape()` 来确定该形状已经与之发生碰撞的 :ref:`Shape3D`\ 。 +\ **注意：**\ 该形状已碰撞的 :ref:`Shape3D` 会被忽略，例如形状在其内部。请使用 :ref:`collide_shape()` 确定该形状已碰撞的 :ref:`Shape3D`\ 。 .. rst-class:: classref-item-separator @@ -196,6 +198,7 @@ PhysicsDirectSpaceState3D \ **注意：**\ 该方法不考虑对象的 ``motion`` 属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsdirectspacestate3dextension.rst b/classes/zh_CN/class_physicsdirectspacestate3dextension.rst index 13c000ff6d..adea3ae780 100644 --- a/classes/zh_CN/class_physicsdirectspacestate3dextension.rst +++ b/classes/zh_CN/class_physicsdirectspacestate3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsDirectSpaceState3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState3DExtension.xml. .. _class_PhysicsDirectSpaceState3DExtension: @@ -31,23 +31,23 @@ PhysicsDirectSpaceState3DExtension .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_closest_point_to_object_volume`\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_closest_point_to_object_volume`\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |required| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| |required| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -76,7 +76,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -90,7 +90,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_get_closest_point_to_object_volume**\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_get_closest_point_to_object_volume**\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -104,7 +104,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -118,7 +118,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -132,7 +132,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -146,7 +146,7 @@ PhysicsDirectSpaceState3DExtension .. rst-class:: classref-method -:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -167,6 +167,7 @@ PhysicsDirectSpaceState3DExtension 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsmaterial.rst b/classes/zh_CN/class_physicsmaterial.rst index fce087dd64..347053ba06 100644 --- a/classes/zh_CN/class_physicsmaterial.rst +++ b/classes/zh_CN/class_physicsmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsMaterial.xml. .. _class_PhysicsMaterial: @@ -115,6 +115,7 @@ PhysicsMaterial 如果为 ``true``\ ，当两个物体碰撞时，物理引擎将使用标记为“粗糙”的物体的摩擦。如果 ``false``\ ，物理引擎将使用所有碰撞物体的最低摩擦力来代替。如果两个碰撞的对象都为 ``true``\ ，物理引擎将使用最高的摩擦力。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicspointqueryparameters2d.rst b/classes/zh_CN/class_physicspointqueryparameters2d.rst index 63722daba5..ad86dfed18 100644 --- a/classes/zh_CN/class_physicspointqueryparameters2d.rst +++ b/classes/zh_CN/class_physicspointqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsPointQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsPointQueryParameters2D.xml. .. _class_PhysicsPointQueryParameters2D: @@ -155,6 +155,7 @@ PhysicsPointQueryParameters2D 要查询的位置，使用全局坐标。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicspointqueryparameters3d.rst b/classes/zh_CN/class_physicspointqueryparameters3d.rst index 87232ed557..3474978838 100644 --- a/classes/zh_CN/class_physicspointqueryparameters3d.rst +++ b/classes/zh_CN/class_physicspointqueryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsPointQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsPointQueryParameters3D.xml. .. _class_PhysicsPointQueryParameters3D: @@ -134,6 +134,7 @@ PhysicsPointQueryParameters3D 要查询的位置，使用全局坐标。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsrayqueryparameters2d.rst b/classes/zh_CN/class_physicsrayqueryparameters2d.rst index 6ce5db8a01..70cef24d52 100644 --- a/classes/zh_CN/class_physicsrayqueryparameters2d.rst +++ b/classes/zh_CN/class_physicsrayqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsRayQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsRayQueryParameters2D.xml. .. _class_PhysicsRayQueryParameters2D: @@ -206,6 +206,7 @@ PhysicsRayQueryParameters2D var collision = get_world_2d().direct_space_state.intersect_ray(query) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsrayqueryparameters3d.rst b/classes/zh_CN/class_physicsrayqueryparameters3d.rst index 666e5c2ce0..091b830ed0 100644 --- a/classes/zh_CN/class_physicsrayqueryparameters3d.rst +++ b/classes/zh_CN/class_physicsrayqueryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsRayQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsRayQueryParameters3D.xml. .. _class_PhysicsRayQueryParameters3D: @@ -225,6 +225,7 @@ PhysicsRayQueryParameters3D var collision = get_world_3d().direct_space_state.intersect_ray(query) .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver2d.rst b/classes/zh_CN/class_physicsserver2d.rst index dbe96bd937..c196b0873c 100644 --- a/classes/zh_CN/class_physicsserver2d.rst +++ b/classes/zh_CN/class_physicsserver2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2D.xml. .. _class_PhysicsServer2D: @@ -690,7 +690,7 @@ enum **BodyParameter**: :ref:`🔗` :ref:`BodyParameter` **BODY_PARAM_CENTER_OF_MASS** = ``4`` -常量，用于在物体局部坐标系中设置/获取该物体的质心位置。该参数的默认值为 ``Vector2(0,0)``\ 。如果该参数从未明确设置，则在设置参数 :ref:`BODY_PARAM_MASS` 或调用 :ref:`body_set_space()` 时，会根据物体的形状重新计算。 +常量，用于在物体局部坐标系中设置/获取该物体的质心位置。该参数的默认值为 ``Vector2(0, 0)``\ 。如果该参数从未明确设置，则在设置参数 :ref:`BODY_PARAM_MASS` 或调用 :ref:`body_set_space()` 时，会根据物体的形状重新计算。 .. _class_PhysicsServer2D_constant_BODY_PARAM_GRAVITY_SCALE: @@ -1219,7 +1219,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| :ref:`🔗` -返回给定区域参数的值。可用参数的列表见 :ref:`AreaParameter`\ 。 +返回给定区域参数的取值。 .. rst-class:: classref-item-separator @@ -1387,7 +1387,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` -设置给定的区域参数的值。可用参数列表见 :ref:`AreaParameter`\ 。 +设置给定区域参数的取值。 .. rst-class:: classref-item-separator @@ -1737,7 +1737,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`CCDMode` **body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` -返回该物体的连续碰撞检测模式（见 :ref:`CCDMode`\ ）。 +返回该物体的连续碰撞检测模式。 .. rst-class:: classref-item-separator @@ -1773,7 +1773,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` -返回该物体的模式（见 :ref:`BodyMode`\ ）。 +返回物体的模式。 .. rst-class:: classref-item-separator @@ -1797,7 +1797,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| :ref:`🔗` -返回给定实体参数的值。有关可用的参数列表，请参阅 :ref:`BodyParameter`\ 。 +返回给定物体参数的取值。 .. rst-class:: classref-item-separator @@ -1857,7 +1857,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| :ref:`🔗` -返回该实体给定状态的值。有关可用状态的列表，请参阅 :ref:`BodyState`\ 。 +返回物体给定状态的取值。 .. rst-class:: classref-item-separator @@ -1993,7 +1993,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) :ref:`🔗` -使用 :ref:`CCDMode` 常量之一设置连续碰撞检测模式。 +设置连续碰撞检测模式。 连续碰撞检测试图预测一个移动的物体将在物理更新之间发生碰撞的位置，而不是移动它并在发生碰撞时纠正它的运动。 @@ -2041,7 +2041,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) :ref:`🔗` -设置该实体的模式。有关可用模式的列表，请参阅 :ref:`BodyMode`\ 。 +设置物体的模式。 .. rst-class:: classref-item-separator @@ -2067,7 +2067,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` -设置给定实体参数的值。有关可用参数列表，请参阅 :ref:`BodyParameter`\ 。 +设置给定物体参数的取值。 .. rst-class:: classref-item-separator @@ -2145,7 +2145,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) :ref:`🔗` -设置实体状态的值。有关可用状态的列表，请参阅 :ref:`BodyState`\ 。 +设置实体状态的值。 \ **注意：**\ 状态更改不会立即生效。状态更改将发生在下一个物理帧上。 @@ -2237,7 +2237,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`float` **damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |const| :ref:`🔗` -返回给定阻尼弹簧关节参数的值。有关可用参数的列表，请参阅 :ref:`DampedSpringParam`\ 。 +返回给定阻尼弹簧关节参数的取值。 .. rst-class:: classref-item-separator @@ -2249,7 +2249,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置给定阻尼弹簧关节参数的值。有关可用参数的列表，请参阅 :ref:`DampedSpringParam`\ 。 +设置给定阻尼弹簧关节参数的取值。 .. rst-class:: classref-item-separator @@ -2273,7 +2273,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) :ref:`🔗` -返回关于 2D 物理引擎当前状态的信息。可用状态的列表见 :ref:`ProcessInfo`\ 。 +返回由 ``process_info`` 指定的物理引擎状态的取值。 .. rst-class:: classref-item-separator @@ -2321,7 +2321,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`float` **joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |const| :ref:`🔗` -返回给定关节参数的值。可用参数的列表见 :ref:`JointParam`\ 。 +返回给定关节参数的取值。 .. rst-class:: classref-item-separator @@ -2333,7 +2333,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` -返回该关节的类型（见 :ref:`JointType`\ ）。 +返回关节的类型。 .. rst-class:: classref-item-separator @@ -2393,7 +2393,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置给定关节参数的值。可用参数的列表见 :ref:`JointParam`\ 。 +设置给定关节参数的取值。 .. rst-class:: classref-item-separator @@ -2405,7 +2405,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`bool` **pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |const| :ref:`🔗` -获取销关节标志（请参阅 :ref:`PinJointFlag` 常量）。 +获取钉固关节的标志。 .. rst-class:: classref-item-separator @@ -2417,7 +2417,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| :ref:`🔗` -返回销关节参数的值。有关可用参数列表，请参阅 :ref:`PinJointParam`\ 。 +返回钉固关节参数的取值。 .. rst-class:: classref-item-separator @@ -2429,7 +2429,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) :ref:`🔗` -设置销关节标志（请参阅 :ref:`PinJointFlag` 常量）。 +设置钉固关节的标志。 .. rst-class:: classref-item-separator @@ -2441,7 +2441,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置销关节参数。有关可用参数列表，请参阅 :ref:`PinJointParam`\ 。 +设置钉固关节的参数。 .. rst-class:: classref-item-separator @@ -2513,7 +2513,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` -返回该形状的类型（见 :ref:`ShapeType`\ ）。 +返回形状的类型。 .. rst-class:: classref-item-separator @@ -2579,7 +2579,7 @@ enum **ProcessInfo**: :ref:`🔗` :ref:`float` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| :ref:`🔗` -返回给定空间参数的值。可用参数的列表见 :ref:`SpaceParameter`\ 。 +返回给定空间参数的取值。 .. rst-class:: classref-item-separator @@ -2615,7 +2615,7 @@ enum **ProcessInfo**: :ref:`🔗` |void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) :ref:`🔗` -设置给定空间参数的值。可用参数的列表见 :ref:`SpaceParameter`\ 。 +设置给定空间参数的取值。 .. rst-class:: classref-item-separator @@ -2630,6 +2630,7 @@ enum **ProcessInfo**: :ref:`🔗` 在物理服务器中创建一个 2D 世界边界形状，并返回标识它的 :ref:`RID`\ 。可使用 :ref:`shape_set_data()` 设置形状的法线方向和距离属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver2dextension.rst b/classes/zh_CN/class_physicsserver2dextension.rst index ee7513f871..239590006d 100644 --- a/classes/zh_CN/class_physicsserver2dextension.rst +++ b/classes/zh_CN/class_physicsserver2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DExtension.xml. .. _class_PhysicsServer2DExtension: @@ -31,287 +31,287 @@ PhysicsServer2DExtension .. table:: :widths: auto - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_attach_canvas_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_canvas_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_pickable`\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_attach_canvas_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_collide_shape`\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_canvas_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CCDMode` | :ref:`_body_get_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState2D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_pickable`\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape_as_one_way_collision`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_circle_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_damped_spring_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_damped_spring_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_end_sync`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_finish`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_flush_queries`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_init`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_damped_spring`\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_groove`\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_pin_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pin_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_rectangle_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_segment_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shape_collide`\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_sync`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_canvas_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_canvas_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_pickable`\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_canvas_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_collide_shape`\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_canvas_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CCDMode` | :ref:`_body_get_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState2D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_pickable`\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_as_one_way_collision`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_circle_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_damped_spring_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_damped_spring_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_sync`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_flush_queries`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_damped_spring`\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_groove`\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_pin_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_rectangle_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_segment_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shape_collide`\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_sync`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -326,7 +326,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_add_shape()` 的可覆盖版本。 @@ -338,7 +338,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_attach_canvas_instance_id()` 的可覆盖版本。 @@ -350,7 +350,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_attach_object_instance_id()` 的可覆盖版本。 @@ -362,7 +362,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_clear_shapes()` 的可覆盖版本。 @@ -374,7 +374,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_area_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_area_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_create()` 的可覆盖版本。 @@ -386,7 +386,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_canvas_instance_id()` 的可覆盖版本。 @@ -398,7 +398,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_collision_layer()` 的可覆盖版本。 @@ -410,7 +410,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_collision_mask()` 的可覆盖版本。 @@ -422,7 +422,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_object_instance_id()` 的可覆盖版本。 @@ -434,7 +434,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_param()` 的可覆盖版本。 @@ -446,7 +446,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_shape()` 的可覆盖版本。 @@ -458,7 +458,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_shape_count()` 的可覆盖版本。 @@ -470,7 +470,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Transform2D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform2D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_shape_transform()` 的可覆盖版本。 @@ -482,7 +482,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_space()` 的可覆盖版本。 @@ -494,7 +494,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Transform2D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform2D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.area_get_transform()` 的可覆盖版本。 @@ -506,7 +506,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_remove_shape()` 的可覆盖版本。 @@ -518,7 +518,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_area_monitor_callback()` 的可覆盖版本。 @@ -530,7 +530,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_collision_layer()` 的可覆盖版本。 @@ -542,7 +542,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_collision_mask()` 的可覆盖版本。 @@ -554,7 +554,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_monitor_callback()` 的可覆盖版本。 @@ -566,7 +566,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_monitorable()` 的可覆盖版本。 @@ -578,7 +578,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_param()` 的可覆盖版本。 @@ -590,7 +590,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_pickable**\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_pickable**\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 如果设置为 ``true``\ ，则允许具有给定 :ref:`RID` 的区域在鼠标光标悬停在其上时检测鼠标输入。 @@ -604,7 +604,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_shape()` 的可覆盖版本。 @@ -616,7 +616,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_shape_disabled()` 的可覆盖版本。 @@ -628,7 +628,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_shape_transform()` 的可覆盖版本。 @@ -640,7 +640,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_space()` 的可覆盖版本。 @@ -652,7 +652,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.area_set_transform()` 的可覆盖版本。 @@ -664,7 +664,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_add_collision_exception()` 的可覆盖版本。 @@ -676,7 +676,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_add_constant_central_force()` 的可覆盖版本。 @@ -688,7 +688,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_add_constant_force()` 的可覆盖版本。 @@ -700,7 +700,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_add_constant_torque()` 的可覆盖版本。 @@ -712,7 +712,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_add_shape()` 的可覆盖版本。 @@ -724,7 +724,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_central_force()` 的可覆盖版本。 @@ -736,7 +736,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_central_impulse()` 的可覆盖版本。 @@ -748,7 +748,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_force()` 的可覆盖版本。 @@ -760,7 +760,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_impulse()` 的可覆盖版本。 @@ -772,7 +772,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_torque()` 的可覆盖版本。 @@ -784,7 +784,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_apply_torque_impulse()` 的可覆盖版本。 @@ -796,7 +796,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_attach_canvas_instance_id()` 的可覆盖版本。 @@ -808,7 +808,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_attach_object_instance_id()` 的可覆盖版本。 @@ -820,7 +820,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_clear_shapes()` 的可覆盖版本。 @@ -832,7 +832,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_body_collide_shape**\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_body_collide_shape**\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| :ref:`🔗` 给定一个 ``body``\ 、一个 ``shape`` 及其各自的参数，如果两者之间发生碰撞，该方法应返回 ``true``\ ，并在 ``results`` 中传递其他详细信息。 @@ -846,7 +846,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_body_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_body_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_create()` 的可覆盖版本。 @@ -858,7 +858,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_canvas_instance_id()` 的可覆盖版本。 @@ -870,7 +870,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回所有添加为给定 ``body`` 的碰撞例外的物体的 :ref:`RID`\ 。另见 :ref:`_body_add_collision_exception()` 和 :ref:`_body_remove_collision_exception()`\ 。 @@ -884,7 +884,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_collision_layer()` 的可覆盖版本。 @@ -896,7 +896,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_collision_mask()` 的可覆盖版本。 @@ -908,7 +908,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_collision_priority()` 的可覆盖版本。 @@ -920,7 +920,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Vector2` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_constant_force()` 的可覆盖版本。 @@ -932,7 +932,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_constant_torque()` 的可覆盖版本。 @@ -944,7 +944,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D` 内部 ``body_get_contacts_reported_depth_threshold`` 方法的可覆盖版本。 @@ -958,7 +958,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`CCDMode` **_body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`CCDMode` **_body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_continuous_collision_detection_mode()` 的可覆盖版本。 @@ -970,7 +970,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_get_direct_state()` 的可覆盖版本。 @@ -982,7 +982,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_max_contacts_reported()` 的可覆盖版本。 @@ -994,7 +994,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_mode()` 的可覆盖版本。 @@ -1006,7 +1006,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_object_instance_id()` 的可覆盖版本。 @@ -1018,7 +1018,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_param()` 的可覆盖版本。 @@ -1030,7 +1030,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_shape()` 的可覆盖版本。 @@ -1042,7 +1042,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_shape_count()` 的可覆盖版本。 @@ -1054,7 +1054,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Transform2D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform2D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_shape_transform()` 的可覆盖版本。 @@ -1066,7 +1066,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_space()` 的可覆盖版本。 @@ -1078,7 +1078,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_get_state()` 的可覆盖版本。 @@ -1090,7 +1090,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_is_omitting_force_integration()` 的可覆盖版本。 @@ -1102,7 +1102,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_remove_collision_exception()` 的可覆盖版本。 @@ -1114,7 +1114,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_remove_shape()` 的可覆盖版本。 @@ -1126,7 +1126,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_reset_mass_properties()` 的可覆盖版本。 @@ -1138,7 +1138,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_axis_velocity()` 的可覆盖版本。 @@ -1150,7 +1150,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_collision_layer()` 的可覆盖版本。 @@ -1162,7 +1162,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_collision_mask()` 的可覆盖版本。 @@ -1174,7 +1174,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_collision_priority()` 的可覆盖版本。 @@ -1186,7 +1186,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_constant_force()` 的可覆盖版本。 @@ -1198,7 +1198,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_constant_torque()` 的可覆盖版本。 @@ -1210,7 +1210,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D` 内部 ``body_set_contacts_reported_depth_threshold`` 方法的可覆盖版本。 @@ -1224,7 +1224,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| :ref:`🔗` +|void| **_body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_continuous_collision_detection_mode()` 的可覆盖版本。 @@ -1236,7 +1236,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_force_integration_callback()` 的可覆盖版本。 @@ -1248,7 +1248,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_max_contacts_reported()` 的可覆盖版本。 @@ -1260,7 +1260,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| :ref:`🔗` +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_mode()` 的可覆盖版本。 @@ -1272,7 +1272,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_omit_force_integration()` 的可覆盖版本。 @@ -1284,7 +1284,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_param()` 的可覆盖版本。 @@ -1296,7 +1296,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_pickable**\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_pickable**\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` 如果设置为 ``true``\ ，则允许具有给定 :ref:`RID` 的物体在鼠标光标悬停在其上时检测鼠标输入。 @@ -1310,7 +1310,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_shape()` 的可覆盖版本。 @@ -1322,7 +1322,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_shape_as_one_way_collision()` 的可覆盖版本。 @@ -1334,7 +1334,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_shape_disabled()` 的可覆盖版本。 @@ -1346,7 +1346,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_shape_transform()` 的可覆盖版本。 @@ -1358,7 +1358,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_space()` 的可覆盖版本。 @@ -1370,7 +1370,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.body_set_state()` 的可覆盖版本。 @@ -1382,7 +1382,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` 在循环的同步阶段，在调用 :ref:`_step()` 之前，分配 ``body`` 来调用给定的 ``callable``\ 。另见 :ref:`_sync()`\ 。 @@ -1396,7 +1396,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.body_test_motion()` 的可覆盖版本。与暴露的实现不同，该方法不会通过 :ref:`PhysicsTestMotionParameters2D` 接受所有参数。 @@ -1408,7 +1408,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.capsule_shape_create()` 的可覆盖版本。 @@ -1420,7 +1420,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_circle_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_circle_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.circle_shape_create()` 的可覆盖版本。 @@ -1432,7 +1432,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.concave_polygon_shape_create()` 的可覆盖版本。 @@ -1444,7 +1444,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.convex_polygon_shape_create()` 的可覆盖版本。 @@ -1456,7 +1456,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.damped_spring_joint_get_param()` 的可覆盖版本。 @@ -1468,7 +1468,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.damped_spring_joint_set_param()` 的可覆盖版本。 @@ -1480,7 +1480,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_end_sync**\ (\ ) |virtual| :ref:`🔗` +|void| **_end_sync**\ (\ ) |virtual| |required| :ref:`🔗` 调用该方法表示物理服务器已停止同步。它处于循环的迭代/物理阶段，即使在单独的线程上运行也可以访问物理对象。另见 :ref:`_sync()`\ 。 @@ -1494,7 +1494,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_finish**\ (\ ) |virtual| :ref:`🔗` +|void| **_finish**\ (\ ) |virtual| |required| :ref:`🔗` 当主循环结束时调用以关闭物理服务器。另见 :ref:`MainLoop._finalize()` 和 :ref:`_init()`\ 。 @@ -1508,7 +1508,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_flush_queries**\ (\ ) |virtual| :ref:`🔗` +|void| **_flush_queries**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`_step()` 之前的每个物理步骤期间调用来处理所有剩余查询。 @@ -1522,7 +1522,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.free_rid()` 的可覆盖版本。 @@ -1534,7 +1534,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| :ref:`🔗` +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.get_process_info()` 的可覆盖版本。 @@ -1546,7 +1546,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_init**\ (\ ) |virtual| :ref:`🔗` +|void| **_init**\ (\ ) |virtual| |required| :ref:`🔗` 在主循环初始化并创建该物理服务器的新实例时调用。另见 :ref:`MainLoop._initialize()` 和 :ref:`_finish()`\ 。 @@ -1560,7 +1560,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |required| |const| :ref:`🔗` 当物理服务器正在处理查询时，应返回 ``true`` 的可覆盖方法。另见 :ref:`_flush_queries()`\ 。 @@ -1574,7 +1574,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_clear()` 的可覆盖版本。 @@ -1586,7 +1586,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_joint_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_joint_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_create()` 的可覆盖版本。 @@ -1598,7 +1598,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_disable_collisions_between_bodies()` 的可覆盖版本。 @@ -1610,7 +1610,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.joint_get_param()` 的可覆盖版本。 @@ -1622,7 +1622,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.joint_get_type()` 的可覆盖版本。 @@ -1634,7 +1634,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.joint_is_disabled_collisions_between_bodies()` 的可覆盖版本。 @@ -1646,7 +1646,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_make_damped_spring()` 的可覆盖版本。 @@ -1658,7 +1658,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_make_groove**\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_groove**\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_make_groove()` 的可覆盖版本。 @@ -1670,7 +1670,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_make_pin()` 的可覆盖版本。 @@ -1682,7 +1682,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.joint_set_param()` 的可覆盖版本。 @@ -1694,7 +1694,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.pin_joint_get_flag()` 的可覆盖版本。 @@ -1706,7 +1706,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.pin_joint_get_param()` 的可覆盖版本。 @@ -1718,7 +1718,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.pin_joint_set_flag()` 的可覆盖版本。 @@ -1730,7 +1730,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.pin_joint_set_param()` 的可覆盖版本。 @@ -1742,7 +1742,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_rectangle_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_rectangle_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.rectangle_shape_create()` 的可覆盖版本。 @@ -1754,7 +1754,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_segment_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_segment_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.segment_shape_create()` 的可覆盖版本。 @@ -1766,7 +1766,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.separation_ray_shape_create()` 的可覆盖版本。 @@ -1778,7 +1778,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.set_active()` 的可覆盖版本。 @@ -1790,7 +1790,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_shape_collide**\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` +:ref:`bool` **_shape_collide**\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| |required| :ref:`🔗` 给定两个形状及其参数，如果两者之间发生碰撞，则应返回 ``true``\ ，并在 ``results`` 中传递其他详细信息。 @@ -1804,7 +1804,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 应返回给定 ``shape`` 的自定义解算器偏差，该偏差定义了当涉及该形状时，物体在接触时被迫分离的程度。 @@ -1818,7 +1818,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.shape_get_data()` 的可覆盖版本。 @@ -1830,7 +1830,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.shape_get_type()` 的可覆盖版本。 @@ -1842,7 +1842,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 应为给定的 ``shape`` 设置自定义解算器偏差。它定义了接触时物体被迫分离的程度。 @@ -1856,7 +1856,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.shape_set_data()` 的可覆盖版本。 @@ -1868,7 +1868,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_space_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_space_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.space_create()` 的可覆盖版本。 @@ -1880,7 +1880,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 应返回在给定的 ``space`` 中最后一个物理步骤期间发生了多少次接触。另见 :ref:`_space_get_contacts()` 和 :ref:`_space_set_debug_contacts()`\ 。 @@ -1894,7 +1894,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`PackedVector2Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedVector2Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 应返回给定 ``space`` 中上一个物理步骤中发生的所有接触的位置。另见 :ref:`_space_get_contact_count()` 和 :ref:`_space_set_debug_contacts()`\ 。 @@ -1908,7 +1908,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.space_get_direct_state()` 的可覆盖版本。 @@ -1920,7 +1920,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.space_get_param()` 的可覆盖版本。 @@ -1932,7 +1932,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` :ref:`PhysicsServer2D.space_is_active()` 的可覆盖版本。 @@ -1944,7 +1944,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.space_set_active()` 的可覆盖版本。 @@ -1956,7 +1956,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 内部使用以允许给定的 ``space`` 存储接触点，最多可达 ``max_contacts``\ 。当 :ref:`SceneTree.debug_collisions_hint` 为 ``true`` 时，或通过在编辑器中勾选“可见碰撞形状”，将自动为主 :ref:`World2D` 的空间设置该设置。仅适用于调试构建。 @@ -1970,7 +1970,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.space_set_param()` 的可覆盖版本。 @@ -1982,9 +1982,9 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` -每个物理步骤期间调用来处理物理模拟。\ ``step`` 是自上一个物理步骤以来经过的时间，单位为秒。它通常与 :ref:`Node.get_physics_process_delta_time()` 相同。 +每个物理步骤期间调用来处理物理模拟。\ ``step`` 是自上一个物理步骤以来经过的时间，单位为秒。通常与 :ref:`Node.get_physics_process_delta_time()` 的返回值相同。 \ :ref:`PhysicsServer2D` 的内部 ``step`` 方法的可覆盖版本。 @@ -1996,7 +1996,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -|void| **_sync**\ (\ ) |virtual| :ref:`🔗` +|void| **_sync**\ (\ ) |virtual| |required| :ref:`🔗` 调用该方法表示物理服务器正在同步，如果在单独的线程上运行则无法访问物理状态。另见 :ref:`_end_sync()`\ 。 @@ -2010,7 +2010,7 @@ PhysicsServer2DExtension .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` :ref:`PhysicsServer2D.world_boundary_shape_create()` 的可覆盖版本。 @@ -2039,6 +2039,7 @@ PhysicsServer2DExtension 如果具有指定实例 ID 的对象被排除在 :ref:`_body_test_motion()` 之外，则返回 ``true``\ 。另见 :ref:`Object.get_instance_id()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver2dmanager.rst b/classes/zh_CN/class_physicsserver2dmanager.rst index 618b44d7be..6fbb2255a3 100644 --- a/classes/zh_CN/class_physicsserver2dmanager.rst +++ b/classes/zh_CN/class_physicsserver2dmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer2DManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DManager.xml. .. _class_PhysicsServer2DManager: @@ -67,6 +67,7 @@ PhysicsServer2DManager 如果优先级 ``priority`` 比当前默认实现的优先级高，则将由名称 ``name`` 标识的 :ref:`PhysicsServer2D` 实现设置为默认实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver3d.rst b/classes/zh_CN/class_physicsserver3d.rst index 3a2e5377fa..57360c6596 100644 --- a/classes/zh_CN/class_physicsserver3d.rst +++ b/classes/zh_CN/class_physicsserver3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3D.xml. .. _class_PhysicsServer3D: @@ -304,6 +304,14 @@ PhysicsServer3D 是负责所有 3D 物理的服务器。它可以直接创建和 +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`soft_body_add_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_apply_point_force`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_apply_point_impulse`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`soft_body_create`\ (\ ) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`soft_body_get_bounds`\ (\ body\: :ref:`RID`\ ) |const| | @@ -322,6 +330,8 @@ PhysicsServer3D 是负责所有 3D 物理的服务器。它可以直接创建和 +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`soft_body_get_pressure_coefficient`\ (\ body\: :ref:`RID`\ ) |const| | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_shrinking_factor`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`soft_body_get_simulation_precision`\ (\ body\: :ref:`RID`\ ) |const| | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`soft_body_get_space`\ (\ body\: :ref:`RID`\ ) |const| | @@ -356,6 +366,8 @@ PhysicsServer3D 是负责所有 3D 物理的服务器。它可以直接创建和 +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`soft_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_shrinking_factor`\ (\ body\: :ref:`RID`, shrinking_factor\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`soft_body_set_simulation_precision`\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`soft_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) | @@ -2783,7 +2795,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) :ref:`🔗` -从 :ref:`BodyMode` 常量之一设置主体模式。 +设置物体的模式。 .. rst-class:: classref-item-separator @@ -2883,7 +2895,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) :ref:`🔗` -设置主体状态（见 :ref:`BodyState` 常量）。 +设置物体的状态。 .. rst-class:: classref-item-separator @@ -2967,7 +2979,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`float` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |const| :ref:`🔗` -获取圆锥体扭曲关节参数（见 :ref:`ConeTwistJointParam` 常量）。 +获取锥体扭转关节的参数。 .. rst-class:: classref-item-separator @@ -2979,7 +2991,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置圆锥体扭曲关节参数（见 :ref:`ConeTwistJointParam` 常量）。 +设置锥体扭转关节的参数。 .. rst-class:: classref-item-separator @@ -3045,7 +3057,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`bool` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`\ ) |const| :ref:`🔗` -返回通用 6DOF 关节的标志值。可用标志列表见 :ref:`G6DOFJointAxisFlag`\ 。 +返回通用六自由度关节的标志值。 .. rst-class:: classref-item-separator @@ -3057,7 +3069,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`float` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`\ ) |const| :ref:`🔗` -返回通用 6DOF 关节的参数值。可用参数列表见 :ref:`G6DOFJointAxisParam`\ 。 +返回通用六自由度关节的参数值。 .. rst-class:: classref-item-separator @@ -3069,7 +3081,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) :ref:`🔗` -设置给定的通用 6DOF 关节标志值。可用标志列表见 :ref:`G6DOFJointAxisFlag`\ 。 +设置通用六自由度关节的标志值。 .. rst-class:: classref-item-separator @@ -3081,7 +3093,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置给定的通用 6DOF 关节参数值。可用参数列表见 :ref:`G6DOFJointAxisParam`\ 。 +设置通用六自由度关节的参数值。 .. rst-class:: classref-item-separator @@ -3093,7 +3105,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) :ref:`🔗` -返回有关 3D 物理引擎当前状态的信息。可用状态的列表见 :ref:`ProcessInfo`\ 。 +返回由 ``process_info`` 指定的物理引擎状态的取值。 .. rst-class:: classref-item-separator @@ -3119,7 +3131,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`bool` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |const| :ref:`🔗` -获取 hinge_joint 标志（见 :ref:`HingeJointFlag` 常量）。 +获取铰链关节标志。 .. rst-class:: classref-item-separator @@ -3131,7 +3143,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`float` **hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |const| :ref:`🔗` -获取 hinge_joint 参数（见 :ref:`HingeJointParam`\ ）。 +获取铰链关节参数。 .. rst-class:: classref-item-separator @@ -3143,7 +3155,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) :ref:`🔗` -设置 hinge_joint 标志（见 :ref:`HingeJointFlag` 常量）。 +设置铰链关节标志。 .. rst-class:: classref-item-separator @@ -3155,7 +3167,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置 hinge_joint 参数（见 :ref:`HingeJointParam` 常量）。 +设置铰链关节参数。 .. rst-class:: classref-item-separator @@ -3347,7 +3359,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| :ref:`🔗` -获取 pin_joint 参数（见 :ref:`PinJointParam` 常量）。 +获取钉固关节参数。 .. rst-class:: classref-item-separator @@ -3383,7 +3395,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置 pin_joint 参数（见 :ref:`PinJointParam` 常量）。 +设置钉固关节的参数。 .. rst-class:: classref-item-separator @@ -3447,7 +3459,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` -返回形状的类型（见 :ref:`ShapeType` 常量）。 +返回形状的类型。 .. rst-class:: classref-item-separator @@ -3485,7 +3497,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`float` **slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| :ref:`🔗` -获取 slider_joint 参数（见 :ref:`SliderJointParam` 常量）。 +获取滑动关节参数。 .. rst-class:: classref-item-separator @@ -3497,7 +3509,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) :ref:`🔗` -获取 slider_joint 参数（见 :ref:`SliderJointParam` 常量）。 +获取滑动关节参数。 .. rst-class:: classref-item-separator @@ -3515,6 +3527,58 @@ enum **BodyAxis**: :ref:`🔗` ---- +.. _class_PhysicsServer3D_method_soft_body_apply_central_force: + +.. rst-class:: classref-method + +|void| **soft_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) :ref:`🔗` + +将力分配并施加到所有点上。力是时间相关的，应在每次物理更新时施加。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3D_method_soft_body_apply_central_impulse: + +.. rst-class:: classref-method + +|void| **soft_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` + +将冲量分配并施加到所有点上。 + +冲量与时间无关！如果每帧都施加冲量会得到与帧率相关的力。因此只应在模拟一次性冲击时使用（否则请使用“_force”函数）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3D_method_soft_body_apply_point_force: + +.. rst-class:: classref-method + +|void| **soft_body_apply_point_force**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) :ref:`🔗` + +将力施加到某个点上。力是时间相关的，应在每次物理更新时施加。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3D_method_soft_body_apply_point_impulse: + +.. rst-class:: classref-method + +|void| **soft_body_apply_point_impulse**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` + +将冲量施加到某个点上。 + +冲量与时间无关！如果每帧都施加冲量会得到与帧率相关的力。因此只应在模拟一次性冲击时使用（否则请使用“_force”函数）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer3D_method_soft_body_create: .. rst-class:: classref-method @@ -3623,6 +3687,18 @@ enum **BodyAxis**: :ref:`🔗` ---- +.. _class_PhysicsServer3D_method_soft_body_get_shrinking_factor: + +.. rst-class:: classref-method + +:ref:`float` **soft_body_get_shrinking_factor**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回给定柔性物体的收缩系数。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer3D_method_soft_body_get_simulation_precision: .. rst-class:: classref-method @@ -3653,7 +3729,7 @@ enum **BodyAxis**: :ref:`🔗` :ref:`Variant` **soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| :ref:`🔗` -返回给定的柔性物体状态（见 :ref:`BodyState` 常量）。 +返回给定的柔性物体状态。 \ **注意：**\ Godot 的默认物理实现不支持 :ref:`BODY_STATE_LINEAR_VELOCITY`\ 、\ :ref:`BODY_STATE_ANGULAR_VELOCITY`\ 、\ :ref:`BODY_STATE_SLEEPING` 或 :ref:`BODY_STATE_CAN_SLEEP`\ 。 @@ -3833,6 +3909,18 @@ enum **BodyAxis**: :ref:`🔗` ---- +.. _class_PhysicsServer3D_method_soft_body_set_shrinking_factor: + +.. rst-class:: classref-method + +|void| **soft_body_set_shrinking_factor**\ (\ body\: :ref:`RID`, shrinking_factor\: :ref:`float`\ ) :ref:`🔗` + +设置给定柔性物体的收缩系数。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer3D_method_soft_body_set_simulation_precision: .. rst-class:: classref-method @@ -3863,7 +3951,7 @@ enum **BodyAxis**: :ref:`🔗` |void| **soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) :ref:`🔗` -设置给定物体的给定物体状态（见 :ref:`BodyState` 常量）。 +设置给定物体的给定物体状态。 \ **注意：**\ Godot 的默认物理实现不支持 :ref:`BODY_STATE_LINEAR_VELOCITY`\ 、\ :ref:`BODY_STATE_ANGULAR_VELOCITY`\ 、\ :ref:`BODY_STATE_SLEEPING` 或 :ref:`BODY_STATE_CAN_SLEEP`\ 。 @@ -4004,6 +4092,7 @@ enum **BodyAxis**: :ref:`🔗` 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver3dextension.rst b/classes/zh_CN/class_physicsserver3dextension.rst index 3cba0055c9..da0f4df0dd 100644 --- a/classes/zh_CN/class_physicsserver3dextension.rst +++ b/classes/zh_CN/class_physicsserver3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DExtension.xml. .. _class_PhysicsServer3DExtension: @@ -31,387 +31,399 @@ PhysicsServer3DExtension .. table:: :widths: auto - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_ray_pickable`\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_user_flags`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_axis_locked`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_axis_lock`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_enable_continuous_collision_detection`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_body_set_user_flags`\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_box_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_cone_twist_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_cone_twist_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_custom_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_cylinder_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_end_sync`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_finish`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_flush_queries`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_generic_6dof_joint_get_param`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_generic_6dof_joint_set_flag`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_generic_6dof_joint_set_param`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_heightmap_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_hinge_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_hinge_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_hinge_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_hinge_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_init`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_joint_get_solver_priority`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_cone_twist`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_generic_6dof`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_hinge`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_hinge_simple`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_make_slider`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_joint_set_solver_priority`\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_a`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_b`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pin_joint_set_local_a`\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pin_joint_set_local_b`\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_margin`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shape_set_margin`\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_slider_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_slider_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_add_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_soft_body_get_bounds`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`RID`\] | :ref:`_soft_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_damping_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_drag_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_linear_stiffness`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_simulation_precision`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_soft_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_total_mass`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_soft_body_is_point_pinned`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_move_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_pin_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_remove_all_pinned_points`\ (\ body\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_remove_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_damping_coefficient`\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_drag_coefficient`\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_linear_stiffness`\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_mesh`\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_pressure_coefficient`\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_simulation_precision`\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_total_mass`\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_set_transform`\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_soft_body_update_rendering_server`\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_sphere_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_sync`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_ray_pickable`\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_user_flags`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_axis_locked`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_lock`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_enable_continuous_collision_detection`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_user_flags`\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_box_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_cone_twist_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cone_twist_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_custom_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_cylinder_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_sync`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_flush_queries`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_generic_6dof_joint_get_param`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_generic_6dof_joint_set_flag`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_generic_6dof_joint_set_param`\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_heightmap_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_hinge_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_hinge_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_hinge_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_hinge_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_joint_get_solver_priority`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_cone_twist`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_generic_6dof`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_hinge`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_hinge_simple`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_slider`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_set_solver_priority`\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_a`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_b`\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_local_a`\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_local_b`\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_margin`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_margin`\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_slider_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_slider_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_add_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_apply_point_force`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_apply_point_impulse`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_soft_body_get_bounds`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_soft_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_damping_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_drag_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_linear_stiffness`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_shrinking_factor`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_simulation_precision`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_soft_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_total_mass`\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_soft_body_is_point_pinned`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_move_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_pin_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_remove_all_pinned_points`\ (\ body\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_remove_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_damping_coefficient`\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_drag_coefficient`\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_linear_stiffness`\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_mesh`\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_pressure_coefficient`\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_shrinking_factor`\ (\ body\: :ref:`RID`, shrinking_factor\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_simulation_precision`\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_total_mass`\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_transform`\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_update_rendering_server`\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_sphere_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_sync`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| |required| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -426,7 +438,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -440,7 +452,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -454,7 +466,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -468,7 +480,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_area_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_area_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -482,7 +494,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -496,7 +508,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -510,7 +522,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -524,7 +536,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -538,7 +550,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -552,7 +564,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -566,7 +578,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform3D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -580,7 +592,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -594,7 +606,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform3D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -608,7 +620,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -622,7 +634,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -636,7 +648,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -650,7 +662,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -664,7 +676,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -678,7 +690,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -692,7 +704,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -706,7 +718,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -720,7 +732,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -734,7 +746,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -748,7 +760,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -762,7 +774,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -776,7 +788,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -790,7 +802,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -804,7 +816,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -818,7 +830,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -832,7 +844,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -846,7 +858,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -860,7 +872,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -874,7 +886,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -888,7 +900,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -902,7 +914,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -916,7 +928,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -930,7 +942,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -944,7 +956,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -958,7 +970,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -972,7 +984,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_body_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_body_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -986,7 +998,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1000,7 +1012,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1014,7 +1026,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1028,7 +1040,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1042,7 +1054,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1056,7 +1068,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1070,7 +1082,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1084,7 +1096,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1098,7 +1110,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1112,7 +1124,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1126,7 +1138,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1140,7 +1152,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1154,7 +1166,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1168,7 +1180,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1182,7 +1194,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Transform3D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Transform3D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1196,7 +1208,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1210,7 +1222,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1224,7 +1236,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_body_get_user_flags**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_body_get_user_flags**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1238,7 +1250,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1252,7 +1264,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1266,7 +1278,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1280,7 +1292,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1294,7 +1306,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1308,7 +1320,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1322,7 +1334,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1336,7 +1348,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1350,7 +1362,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1364,7 +1376,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1378,7 +1390,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1392,7 +1404,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1406,7 +1418,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1420,7 +1432,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1434,7 +1446,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1448,7 +1460,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1462,7 +1474,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1476,7 +1488,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| :ref:`🔗` +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1490,7 +1502,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1504,7 +1516,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1518,7 +1530,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1532,7 +1544,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1546,7 +1558,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1560,7 +1572,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1574,7 +1586,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1588,7 +1600,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1602,7 +1614,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| :ref:`🔗` +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1616,7 +1628,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_body_set_user_flags**\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_body_set_user_flags**\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1630,7 +1642,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1644,7 +1656,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_box_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_box_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1658,7 +1670,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1672,7 +1684,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1686,7 +1698,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1700,7 +1712,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1714,7 +1726,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1728,7 +1740,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_custom_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_custom_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1742,7 +1754,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_cylinder_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_cylinder_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1756,7 +1768,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_end_sync**\ (\ ) |virtual| :ref:`🔗` +|void| **_end_sync**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1770,7 +1782,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_finish**\ (\ ) |virtual| :ref:`🔗` +|void| **_finish**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1784,7 +1796,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_flush_queries**\ (\ ) |virtual| :ref:`🔗` +|void| **_flush_queries**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1798,7 +1810,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1812,7 +1824,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1826,7 +1838,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1840,7 +1852,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1854,7 +1866,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: :ref:`Axis`, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1868,7 +1880,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| :ref:`🔗` +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1882,7 +1894,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_heightmap_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_heightmap_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1896,7 +1908,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1910,7 +1922,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1924,7 +1936,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1938,7 +1950,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1952,7 +1964,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_init**\ (\ ) |virtual| :ref:`🔗` +|void| **_init**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1966,7 +1978,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1980,7 +1992,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1994,7 +2006,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_joint_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_joint_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2008,7 +2020,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2022,7 +2034,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2036,7 +2048,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2050,7 +2062,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2064,7 +2076,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2078,7 +2090,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2092,7 +2104,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2106,7 +2118,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_hinge_simple**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_hinge_simple**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2120,7 +2132,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2134,7 +2146,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2148,7 +2160,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2162,7 +2174,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2176,7 +2188,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2190,7 +2202,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2204,7 +2216,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2218,7 +2230,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2232,7 +2244,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2246,7 +2258,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2260,7 +2272,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2274,7 +2286,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2288,7 +2300,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2302,7 +2314,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2316,7 +2328,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2330,7 +2342,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2344,7 +2356,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2358,7 +2370,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2372,7 +2384,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2386,7 +2398,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2400,7 +2412,63 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_apply_central_force: + +.. rst-class:: classref-method + +|void| **_soft_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_apply_central_impulse: + +.. rst-class:: classref-method + +|void| **_soft_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_apply_point_force: + +.. rst-class:: classref-method + +|void| **_soft_body_apply_point_force**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_apply_point_impulse: + +.. rst-class:: classref-method + +|void| **_soft_body_apply_point_impulse**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2414,7 +2482,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_soft_body_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_soft_body_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2428,7 +2496,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`AABB` **_soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`AABB` **_soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2442,7 +2510,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **_soft_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`RID`\] **_soft_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2456,7 +2524,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2470,7 +2538,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2484,7 +2552,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2498,7 +2566,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2512,7 +2580,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2526,7 +2594,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Vector3` **_soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector3` **_soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2540,7 +2608,21 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_get_shrinking_factor: + +.. rst-class:: classref-method + +:ref:`float` **_soft_body_get_shrinking_factor**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2554,7 +2636,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2568,7 +2650,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2582,7 +2664,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`Variant` **_soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2596,7 +2678,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2610,7 +2692,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2624,7 +2706,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2638,7 +2720,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2652,7 +2734,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2666,7 +2748,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2680,7 +2762,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2694,7 +2776,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2708,7 +2790,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2722,7 +2804,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2736,7 +2818,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2750,7 +2832,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2764,7 +2846,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2778,7 +2860,21 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` + +.. container:: contribute + + 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicsServer3DExtension_private_method__soft_body_set_shrinking_factor: + +.. rst-class:: classref-method + +|void| **_soft_body_set_shrinking_factor**\ (\ body\: :ref:`RID`, shrinking_factor\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2792,7 +2888,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2806,7 +2902,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2820,7 +2916,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2834,7 +2930,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2848,7 +2944,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2862,7 +2958,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| :ref:`🔗` +|void| **_soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2876,7 +2972,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_space_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_space_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2890,7 +2986,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2904,7 +3000,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`PackedVector3Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedVector3Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2918,7 +3014,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| :ref:`🔗` +:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2932,7 +3028,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2946,7 +3042,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -2960,7 +3056,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2974,7 +3070,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -2988,7 +3084,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -3002,7 +3098,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_sphere_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_sphere_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -3016,7 +3112,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| :ref:`🔗` +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -3030,7 +3126,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -|void| **_sync**\ (\ ) |virtual| :ref:`🔗` +|void| **_sync**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -3044,7 +3140,7 @@ PhysicsServer3DExtension .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| :ref:`🔗` +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -3079,6 +3175,7 @@ PhysicsServer3DExtension 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver3dmanager.rst b/classes/zh_CN/class_physicsserver3dmanager.rst index c9935d5cf3..bbf72e0b01 100644 --- a/classes/zh_CN/class_physicsserver3dmanager.rst +++ b/classes/zh_CN/class_physicsserver3dmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer3DManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DManager.xml. .. _class_PhysicsServer3DManager: @@ -67,6 +67,7 @@ PhysicsServer3DManager 如果优先级 ``priority`` 比当前默认实现的优先级高，则将由名称 ``name`` 标识的 :ref:`PhysicsServer3D` 实现设置为默认实现。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsserver3drenderingserverhandler.rst b/classes/zh_CN/class_physicsserver3drenderingserverhandler.rst index 82723bfdf0..571e63e9d2 100644 --- a/classes/zh_CN/class_physicsserver3drenderingserverhandler.rst +++ b/classes/zh_CN/class_physicsserver3drenderingserverhandler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsServer3DRenderingServerHandler.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DRenderingServerHandler.xml. .. _class_PhysicsServer3DRenderingServerHandler: @@ -22,19 +22,19 @@ PhysicsServer3DRenderingServerHandler .. table:: :widths: auto - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_aabb`\ (\ aabb\: :ref:`AABB`\ ) |virtual| | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_aabb`\ (\ aabb\: :ref:`AABB`\ ) | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) | - +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_aabb`\ (\ aabb\: :ref:`AABB`\ ) |virtual| |required| | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| |required| | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| |required| | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_aabb`\ (\ aabb\: :ref:`AABB`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -49,7 +49,7 @@ PhysicsServer3DRenderingServerHandler .. rst-class:: classref-method -|void| **_set_aabb**\ (\ aabb\: :ref:`AABB`\ ) |virtual| :ref:`🔗` +|void| **_set_aabb**\ (\ aabb\: :ref:`AABB`\ ) |virtual| |required| :ref:`🔗` 由 :ref:`PhysicsServer3D` 调用以设置 :ref:`SoftBody3D` 的边界框。 @@ -61,7 +61,7 @@ PhysicsServer3DRenderingServerHandler .. rst-class:: classref-method -|void| **_set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` 由 :ref:`PhysicsServer3D` 调用，以在 ``vertex_id`` 指定的索引处设置 :ref:`SoftBody3D` 顶点的法线。 @@ -75,7 +75,7 @@ PhysicsServer3DRenderingServerHandler .. rst-class:: classref-method -|void| **_set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` +|void| **_set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| |required| :ref:`🔗` 由 :ref:`PhysicsServer3D` 调用，以在 ``vertex_id`` 指定的索引处设置 :ref:`SoftBody3D` 顶点的位置。 @@ -118,6 +118,7 @@ PhysicsServer3DRenderingServerHandler 在由 ``vertex_id`` 指定的索引处设置该 :ref:`SoftBody3D` 顶点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsshapequeryparameters2d.rst b/classes/zh_CN/class_physicsshapequeryparameters2d.rst index 0976a389ea..9d2b6fae17 100644 --- a/classes/zh_CN/class_physicsshapequeryparameters2d.rst +++ b/classes/zh_CN/class_physicsshapequeryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsShapeQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsShapeQueryParameters2D.xml. .. _class_PhysicsShapeQueryParameters2D: @@ -12,14 +12,14 @@ PhysicsShapeQueryParameters2D **继承：** :ref:`RefCounted` **<** :ref:`Object` -为 :ref:`PhysicsDirectSpaceState2D.intersect_shape()` 提供参数。 +为 :ref:`PhysicsDirectSpaceState2D` 的方法提供参数。 .. rst-class:: classref-introduction-group 描述 ---- -你可以通过修改这个对象的形状等属性来为 :ref:`PhysicsDirectSpaceState2D.intersect_shape()` 配置参数。 +可以通过修改这个对象的形状等属性来为 :ref:`PhysicsDirectSpaceState2D` 的方法配置参数。 .. rst-class:: classref-reftable-group @@ -190,7 +190,7 @@ PhysicsShapeQueryParameters2D - |void| **set_shape_rid**\ (\ value\: :ref:`RID`\ ) - :ref:`RID` **get_shape_rid**\ (\ ) -The queried shape's :ref:`RID` that will be used for collision/intersection queries. Use this over :ref:`shape` if you want to optimize for performance using the Servers API: +将用于碰撞/相交查询的形状的 :ref:`RID`\ 。如果你想要使用服务器 API 优化性能，请使用这个属性而不是 :ref:`shape`\ ： .. tabs:: @@ -200,13 +200,13 @@ The queried shape's :ref:`RID` that will be used for collision/inters var shape_rid = PhysicsServer2D.circle_shape_create() var radius = 64 PhysicsServer2D.shape_set_data(shape_rid, radius) - + var params = PhysicsShapeQueryParameters2D.new() params.shape_rid = shape_rid - - # Execute physics queries here... - - # Release the shape when done with physics queries. + + # 在此处执行物理查询... + + # 完成物理查询后释放形状。 PhysicsServer2D.free_rid(shape_rid) .. code-tab:: csharp @@ -214,13 +214,13 @@ The queried shape's :ref:`RID` that will be used for collision/inters RID shapeRid = PhysicsServer2D.CircleShapeCreate(); int radius = 64; PhysicsServer2D.ShapeSetData(shapeRid, radius); - + var params = new PhysicsShapeQueryParameters2D(); params.ShapeRid = shapeRid; - - // Execute physics queries here... - - // Release the shape when done with physics queries. + + // 在此处执行物理查询... + + // 完成物理查询后释放形状。 PhysicsServer2D.FreeRid(shapeRid); @@ -243,6 +243,7 @@ The queried shape's :ref:`RID` that will be used for collision/inters 被查询形状的变换矩阵。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicsshapequeryparameters3d.rst b/classes/zh_CN/class_physicsshapequeryparameters3d.rst index f4a584677f..ab6fa3982d 100644 --- a/classes/zh_CN/class_physicsshapequeryparameters3d.rst +++ b/classes/zh_CN/class_physicsshapequeryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsShapeQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsShapeQueryParameters3D.xml. .. _class_PhysicsShapeQueryParameters3D: @@ -12,14 +12,14 @@ PhysicsShapeQueryParameters3D **继承：** :ref:`RefCounted` **<** :ref:`Object` -为 :ref:`PhysicsDirectSpaceState3D.intersect_shape()` 提供参数。 +为 :ref:`PhysicsDirectSpaceState3D` 的方法提供参数。 .. rst-class:: classref-introduction-group 描述 ---- -你可以通过修改这个对象的形状等属性来为 :ref:`PhysicsDirectSpaceState3D.intersect_shape()` 配置参数。 +可以通过修改这个对象的形状等属性来为 :ref:`PhysicsDirectSpaceState3D` 的方法配置参数。 .. rst-class:: classref-reftable-group @@ -197,29 +197,29 @@ The queried shape's :ref:`RID` that will be used for collision/inters .. code-tab:: gdscript - var shape_rid = PhysicsServer3D.shape_create(PhysicsServer3D.SHAPE_SPHERE) + var shape_rid = PhysicsServer3D.sphere_shape_create() var radius = 2.0 PhysicsServer3D.shape_set_data(shape_rid, radius) - + var params = PhysicsShapeQueryParameters3D.new() params.shape_rid = shape_rid - + # Execute physics queries here... - + # Release the shape when done with physics queries. PhysicsServer3D.free_rid(shape_rid) .. code-tab:: csharp - RID shapeRid = PhysicsServer3D.ShapeCreate(PhysicsServer3D.ShapeType.Sphere); + RID shapeRid = PhysicsServer3D.SphereShapeCreate(); float radius = 2.0f; PhysicsServer3D.ShapeSetData(shapeRid, radius); - + var params = new PhysicsShapeQueryParameters3D(); params.ShapeRid = shapeRid; - + // Execute physics queries here... - + // Release the shape when done with physics queries. PhysicsServer3D.FreeRid(shapeRid); @@ -243,6 +243,7 @@ The queried shape's :ref:`RID` that will be used for collision/inters 被查询形状的变换矩阵。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicstestmotionparameters2d.rst b/classes/zh_CN/class_physicstestmotionparameters2d.rst index 29bbe5813a..8dfe0e9f18 100644 --- a/classes/zh_CN/class_physicstestmotionparameters2d.rst +++ b/classes/zh_CN/class_physicstestmotionparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsTestMotionParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionParameters2D.xml. .. _class_PhysicsTestMotionParameters2D: @@ -174,6 +174,7 @@ PhysicsTestMotionParameters2D 如果设置为 ``false``\ ，则只会汇报移动造成的碰撞，一般符合预期行为。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicstestmotionparameters3d.rst b/classes/zh_CN/class_physicstestmotionparameters3d.rst index 2b52ecbff3..ce5a082f77 100644 --- a/classes/zh_CN/class_physicstestmotionparameters3d.rst +++ b/classes/zh_CN/class_physicstestmotionparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsTestMotionParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionParameters3D.xml. .. _class_PhysicsTestMotionParameters3D: @@ -193,6 +193,7 @@ PhysicsTestMotionParameters3D 如果设置为 ``false``\ ，则只会汇报移动造成的碰撞，一般符合预期行为。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicstestmotionresult2d.rst b/classes/zh_CN/class_physicstestmotionresult2d.rst index bb9d7bc1d1..6beee491ca 100644 --- a/classes/zh_CN/class_physicstestmotionresult2d.rst +++ b/classes/zh_CN/class_physicstestmotionresult2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsTestMotionResult2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionResult2D.xml. .. _class_PhysicsTestMotionResult2D: @@ -219,6 +219,7 @@ PhysicsTestMotionResult2D 返回移动对象的在碰撞前的运动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_physicstestmotionresult3d.rst b/classes/zh_CN/class_physicstestmotionresult3d.rst index e671220d47..6afc845427 100644 --- a/classes/zh_CN/class_physicstestmotionresult3d.rst +++ b/classes/zh_CN/class_physicstestmotionresult3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PhysicsTestMotionResult3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionResult3D.xml. .. _class_PhysicsTestMotionResult3D: @@ -233,6 +233,7 @@ PhysicsTestMotionResult3D 返回移动对象的在碰撞前的运动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pinjoint2d.rst b/classes/zh_CN/class_pinjoint2d.rst index 82e84b7141..b04c3b50c3 100644 --- a/classes/zh_CN/class_pinjoint2d.rst +++ b/classes/zh_CN/class_pinjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PinJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PinJoint2D.xml. .. _class_PinJoint2D: @@ -151,6 +151,7 @@ PinJoint2D 这个值越高，与被牵制的两个物体之间的的联系就越灵活。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pinjoint3d.rst b/classes/zh_CN/class_pinjoint3d.rst index 75ad84c9c6..09b44632dc 100644 --- a/classes/zh_CN/class_pinjoint3d.rst +++ b/classes/zh_CN/class_pinjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PinJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PinJoint3D.xml. .. _class_PinJoint3D: @@ -176,6 +176,7 @@ enum **Param**: :ref:`🔗` 设置指定参数的值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdercubemap.rst b/classes/zh_CN/class_placeholdercubemap.rst index 56c3e35f52..4070fe5116 100644 --- a/classes/zh_CN/class_placeholdercubemap.rst +++ b/classes/zh_CN/class_placeholdercubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderCubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderCubemap.xml. .. _class_PlaceholderCubemap: @@ -28,6 +28,7 @@ PlaceholderCubemap \ **注意：**\ 该类不适用于渲染或在着色器中使用。不保证计算 UV 之类的操作有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdercubemaparray.rst b/classes/zh_CN/class_placeholdercubemaparray.rst index 9581eaff24..3648d00296 100644 --- a/classes/zh_CN/class_placeholdercubemaparray.rst +++ b/classes/zh_CN/class_placeholdercubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderCubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderCubemapArray.xml. .. _class_PlaceholderCubemapArray: @@ -28,6 +28,7 @@ PlaceholderCubemapArray \ **注意：**\ 该类不适用于渲染或在着色器中使用。不保证计算 UV 之类的操作有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdermaterial.rst b/classes/zh_CN/class_placeholdermaterial.rst index 0df7f1d95b..b367702ddb 100644 --- a/classes/zh_CN/class_placeholdermaterial.rst +++ b/classes/zh_CN/class_placeholdermaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderMaterial.xml. .. _class_PlaceholderMaterial: @@ -26,6 +26,7 @@ PlaceholderMaterial - 由于引擎版本或构建不同而缺失这个子类（例如禁用了某些模块）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdermesh.rst b/classes/zh_CN/class_placeholdermesh.rst index 09272a706d..13a1567460 100644 --- a/classes/zh_CN/class_placeholdermesh.rst +++ b/classes/zh_CN/class_placeholdermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderMesh.xml. .. _class_PlaceholderMesh: @@ -60,6 +60,7 @@ PlaceholderMesh 局部空间中，包含这个网格的最小 :ref:`AABB`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdertexture2d.rst b/classes/zh_CN/class_placeholdertexture2d.rst index 099b03b2e6..b7518451d0 100644 --- a/classes/zh_CN/class_placeholdertexture2d.rst +++ b/classes/zh_CN/class_placeholdertexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture2D.xml. .. _class_PlaceholderTexture2D: @@ -64,6 +64,7 @@ PlaceholderTexture2D 纹理的尺寸（单位为像素）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdertexture2darray.rst b/classes/zh_CN/class_placeholdertexture2darray.rst index 24f59d3984..d82cbc9c80 100644 --- a/classes/zh_CN/class_placeholdertexture2darray.rst +++ b/classes/zh_CN/class_placeholdertexture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderTexture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture2DArray.xml. .. _class_PlaceholderTexture2DArray: @@ -28,6 +28,7 @@ PlaceholderTexture2DArray \ **注意：**\ 设计这个类的目的并不是作为渲染的实际纹理。不保证能够在着色器和材质中正常工作（例如对 UV 进行计算）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdertexture3d.rst b/classes/zh_CN/class_placeholdertexture3d.rst index 1aadcc546f..98f7b8a7b8 100644 --- a/classes/zh_CN/class_placeholdertexture3d.rst +++ b/classes/zh_CN/class_placeholdertexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture3D.xml. .. _class_PlaceholderTexture3D: @@ -62,6 +62,7 @@ PlaceholderTexture3D 纹理的尺寸（单位为像素）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_placeholdertexturelayered.rst b/classes/zh_CN/class_placeholdertexturelayered.rst index a4b4c4b137..c0a8a74e78 100644 --- a/classes/zh_CN/class_placeholdertexturelayered.rst +++ b/classes/zh_CN/class_placeholdertexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaceholderTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTextureLayered.xml. .. _class_PlaceholderTextureLayered: @@ -83,6 +83,7 @@ PlaceholderTextureLayered 各层纹理的尺寸（单位为像素）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_plane.rst b/classes/zh_CN/class_plane.rst index d286c907a5..a47f4993df 100644 --- a/classes/zh_CN/class_plane.rst +++ b/classes/zh_CN/class_plane.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Plane.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Plane.xml. .. _class_Plane: @@ -516,6 +516,7 @@ Plane 返回该 **Plane** 的负值。和写 ``Plane(-p.normal, -p.d)`` 相同。该操作翻转了法线向量的方向，也翻转了距离值，得到的 Plane 位于同一个位置，但是朝向相反的方向。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_planemesh.rst b/classes/zh_CN/class_planemesh.rst index a0d7ad7409..119379cee1 100644 --- a/classes/zh_CN/class_planemesh.rst +++ b/classes/zh_CN/class_planemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PlaneMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaneMesh.xml. .. _class_PlaneMesh: @@ -121,7 +121,7 @@ enum **Orientation**: :ref:`🔗` - |void| **set_orientation**\ (\ value\: :ref:`Orientation`\ ) - :ref:`Orientation` **get_orientation**\ (\ ) -**PlaneMesh** 的朝向。可选项见 :ref:`Orientation`\ 。 +**PlaneMesh** 的朝向。 .. rst-class:: classref-item-separator @@ -175,6 +175,7 @@ enum **Orientation**: :ref:`🔗` 沿 X 轴细分的次数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pointlight2d.rst b/classes/zh_CN/class_pointlight2d.rst index 7426022340..a4c2ffc46f 100644 --- a/classes/zh_CN/class_pointlight2d.rst +++ b/classes/zh_CN/class_pointlight2d.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PointLight2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PointLight2D.xml. .. _class_PointLight2D: @@ -123,6 +123,7 @@ PointLight2D :ref:`texture` 的缩放系数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_pointmesh.rst b/classes/zh_CN/class_pointmesh.rst index a670fff63a..799b3275ce 100644 --- a/classes/zh_CN/class_pointmesh.rst +++ b/classes/zh_CN/class_pointmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PointMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PointMesh.xml. .. _class_PointMesh: @@ -12,20 +12,21 @@ PointMesh **继承：** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -使用单个点图元的网格。 +单点图元网格。 .. rst-class:: classref-introduction-group 描述 ---- -PointMesh 由一个点构成。这个点不依赖于三角形，而是作为屏幕上的一个矩形来渲染，大小是固定的。旨在用于粒子系统，但也可以作为固定大小公告板精灵的轻量级渲染方法（例如在点云中使用）。 +**PointMesh** 由一个点构成的基本网格。这个点不依赖于三角形，而是作为屏幕上的一个矩形来渲染，大小是固定的。旨在用于粒子系统，但也可以作为固定大小公告板精灵的轻量级渲染方法（例如在点云中使用）。 -PointMesh 必须使用具有点大小的材质。点的大小可以在着色器中通过 ``POINT_SIZE`` 访问，也可以在 :ref:`BaseMaterial3D` 中设置 :ref:`BaseMaterial3D.use_point_size` 并通过变量 :ref:`BaseMaterial3D.point_size` 访问。 +为了显示，单点网格必须使用具有点大小的材质。点的大小可以在着色器中通过内置的 ``POINT_SIZE`` 访问，也可以在 :ref:`BaseMaterial3D` 中设置 :ref:`BaseMaterial3D.use_point_size` 并通过变量 :ref:`BaseMaterial3D.point_size` 访问。 -使用 PointMesh 时，会忽略平时用来改变顶点的属性，包括公告板模式、生长、剔除面等。 +\ **注意：**\ 使用单点网格时，会忽略平时能够影响顶点的属性，包括 :ref:`BaseMaterial3D.billboard_mode`\ 、\ :ref:`BaseMaterial3D.grow`\ 、\ :ref:`BaseMaterial3D.cull_mode` 等。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_polygon2d.rst b/classes/zh_CN/class_polygon2d.rst index 30cb4cba66..b611af48bb 100644 --- a/classes/zh_CN/class_polygon2d.rst +++ b/classes/zh_CN/class_polygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Polygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Polygon2D.xml. .. _class_Polygon2D: @@ -455,6 +455,7 @@ Polygon2D 由一组点定义。每个点都连接到下一个点，最后一个 设置指定骨骼的权重值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_polygonoccluder3d.rst b/classes/zh_CN/class_polygonoccluder3d.rst index 67ba1258a9..48ee839726 100644 --- a/classes/zh_CN/class_polygonoccluder3d.rst +++ b/classes/zh_CN/class_polygonoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PolygonOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PolygonOccluder3D.xml. .. _class_PolygonOccluder3D: @@ -69,6 +69,7 @@ PolygonOccluder3D **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_polygonpathfinder.rst b/classes/zh_CN/class_polygonpathfinder.rst index c68587723a..13e4c8ea08 100644 --- a/classes/zh_CN/class_polygonpathfinder.rst +++ b/classes/zh_CN/class_polygonpathfinder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PolygonPathFinder.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PolygonPathFinder.xml. .. _class_PolygonPathFinder: @@ -210,6 +210,7 @@ PolygonPathFinder .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_popup.rst b/classes/zh_CN/class_popup.rst index c65f65d720..c6852564d8 100644 --- a/classes/zh_CN/class_popup.rst +++ b/classes/zh_CN/class_popup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Popup.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Popup.xml. .. _class_Popup: @@ -31,19 +31,25 @@ Popup .. table:: :widths: auto - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | borderless | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | popup_window | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | transient | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | unresizable | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | visible | ``false`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | wrap_controls | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | borderless | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | maximize_disabled | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | minimize_disabled | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | popup_window | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | popup_wm_hint | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | transient | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | unresizable | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | visible | ``false`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | wrap_controls | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -63,6 +69,7 @@ Popup 当该弹出窗口被隐藏时发出。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_popupmenu.rst b/classes/zh_CN/class_popupmenu.rst index ff1115fdf6..1ee0f3cca6 100644 --- a/classes/zh_CN/class_popupmenu.rst +++ b/classes/zh_CN/class_popupmenu.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PopupMenu.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupMenu.xml. .. _class_PopupMenu: @@ -67,149 +67,153 @@ PopupMenu .. table:: :widths: auto - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`activate_item_by_event`\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_radio_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_radio_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_multistate_item`\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_radio_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_radio_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_separator`\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_submenu_item`\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_submenu_node_item`\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ free_submenus\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_focused_item`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_item_accelerator`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_icon_max_width`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_indent`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate_max`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shortcut` | :ref:`get_item_shortcut`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_submenu`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_item_submenu_node`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checkable`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checked`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_radio_checkable`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_shortcut_disabled`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_native_menu`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_system_menu`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`scroll_to_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_focused_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_accelerator`\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_radio_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_separator`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_checked`\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon`\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_max_width`\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_modulate`\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_id`\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_indent`\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_language`\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_metadata`\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_multistate`\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_multistate_max`\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_shortcut`\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_shortcut_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_submenu`\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_submenu_node`\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text`\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text_direction`\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip`\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`toggle_item_checked`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`toggle_item_multistate`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`activate_item_by_event`\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_multistate_item`\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_item`\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_node_item`\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ free_submenus\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_focused_item`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_item_accelerator`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_item_auto_translate_mode`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_icon_max_width`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_indent`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate_max`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shortcut` | :ref:`get_item_shortcut`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_submenu`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_item_submenu_node`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checked`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_radio_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_shortcut_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_native_menu`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_system_menu`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_focused_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_accelerator`\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_radio_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_separator`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_auto_translate_mode`\ (\ index\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_checked`\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_max_width`\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_modulate`\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_indent`\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_language`\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate`\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate_max`\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut`\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu`\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu_node`\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text_direction`\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_checked`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_multistate`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -662,7 +666,7 @@ ID 为 ``id`` 的菜单项被按下或者由快捷键激活时发出。 func _ready(): add_multistate_item("菜单项", 3, 0) - + index_pressed.connect(func(index: int): toggle_item_multistate(index) match get_item_multistate(index): @@ -810,6 +814,18 @@ ID 为 ``id`` 的菜单项被按下或者由快捷键激活时发出。 ---- +.. _class_PopupMenu_method_get_item_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_item_auto_translate_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的菜单项的自动翻译模式。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_get_item_icon: .. rst-class:: classref-method @@ -1196,6 +1212,20 @@ ID 为 ``id`` 的菜单项被按下或者由快捷键激活时发出。 ---- +.. _class_PopupMenu_method_set_item_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_item_auto_translate_mode**\ (\ index\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`🔗` + +设置索引为 ``index`` 的菜单项的自动翻译模式。 + +项目默认使用 :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT`\ ，表示使用与 **PopupMenu** 相同的自动翻译模式。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_set_item_checked: .. rst-class:: classref-method @@ -1852,6 +1882,7 @@ ID 为 ``id`` 的菜单项被按下或者由快捷键激活时发出。 用于分隔符的 :ref:`StyleBox`\ 。请参阅 :ref:`add_separator()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_popuppanel.rst b/classes/zh_CN/class_popuppanel.rst index 34000a1d19..3f191386bb 100644 --- a/classes/zh_CN/class_popuppanel.rst +++ b/classes/zh_CN/class_popuppanel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PopupPanel.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupPanel.xml. .. _class_PopupPanel: @@ -65,6 +65,7 @@ PopupPanel 用于背景面板的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_portablecompressedtexture2d.rst b/classes/zh_CN/class_portablecompressedtexture2d.rst index 57cd1ef47f..21a06b7c53 100644 --- a/classes/zh_CN/class_portablecompressedtexture2d.rst +++ b/classes/zh_CN/class_portablecompressedtexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PortableCompressedTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PortableCompressedTexture2D.xml. .. _class_PortableCompressedTexture2D: @@ -62,6 +62,8 @@ PortableCompressedTexture2D +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_keeping_all_compressed_buffers`\ (\ ) |static| | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_basisu_compressor_params`\ (\ uastc_level\: :ref:`int`, rdo_quality_loss\: :ref:`float`\ ) | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_keep_all_compressed_buffers`\ (\ keep\: :ref:`bool`\ ) |static| | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -152,6 +154,18 @@ enum **CompressionMode**: :ref:`🔗` **COMPRESSION_MODE_ASTC** = ``6`` + +.. container:: contribute + + 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + + + .. rst-class:: classref-section-separator ---- @@ -176,6 +190,8 @@ enum **CompressionMode**: :ref:`🔗` 之前设置才能生效。 + .. rst-class:: classref-item-separator ---- @@ -254,6 +270,20 @@ enum **CompressionMode**: :ref:`🔗`, rdo_quality_loss\: :ref:`float`\ ) :ref:`🔗` + +设置 Basis Universal 压缩的压缩器参数。另见 :ref:`ResourceImporterTexture` 中的设置。 + +\ **注意：**\ 必须在 :ref:`create_from_image()` 前设置才会生效。 + +.. rst-class:: classref-item-separator + +---- + .. _class_PortableCompressedTexture2D_method_set_keep_all_compressed_buffers: .. rst-class:: classref-method @@ -263,6 +293,7 @@ enum **CompressionMode**: :ref:`🔗`\ ) - :ref:`bool` **get_flip_faces**\ (\ ) -打开后会颠倒各个三角形中顶点的顺序，导致绘制网格的背面。 +如果为 ``true``\ ，则会颠倒各个三角形中顶点的顺序，导致绘制网格的背面。 和在 :ref:`BaseMaterial3D.cull_mode` 中使用 :ref:`BaseMaterial3D.CULL_FRONT` 的效果一致。 @@ -214,6 +214,7 @@ PrimitiveMesh 请求根据其属性更新该基本网格。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_prismmesh.rst b/classes/zh_CN/class_prismmesh.rst index e0ce1351e9..07b0f6fcd2 100644 --- a/classes/zh_CN/class_prismmesh.rst +++ b/classes/zh_CN/class_prismmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PrismMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PrismMesh.xml. .. _class_PrismMesh: @@ -132,6 +132,7 @@ PrismMesh 沿 X 轴添加的边循环数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_proceduralskymaterial.rst b/classes/zh_CN/class_proceduralskymaterial.rst index f774cfe654..0b7dbac651 100644 --- a/classes/zh_CN/class_proceduralskymaterial.rst +++ b/classes/zh_CN/class_proceduralskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ProceduralSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProceduralSkyMaterial.xml. .. _class_ProceduralSkyMaterial: @@ -307,6 +307,7 @@ ProceduralSkyMaterial 如果为 ``true``\ ，则启用去色带。去色带会增加少量噪点，这有助于减少天空中颜色的平滑变化而出现的色带。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_progressbar.rst b/classes/zh_CN/class_progressbar.rst index 1d4f5e9fe8..1527989d26 100644 --- a/classes/zh_CN/class_progressbar.rst +++ b/classes/zh_CN/class_progressbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ProgressBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProgressBar.xml. .. _class_ProgressBar: @@ -19,7 +19,7 @@ ProgressBar 描述 ---- -将百分比可视化表示的控件。显示从右到左的填充百分比。 +将百分比可视化表示的控件。在中央显示填充百分比。还可以用来显示尚未确定的进度。如果需要更多填充模式，请改用 :ref:`TextureProgressBar`\ 。 .. rst-class:: classref-reftable-group @@ -275,6 +275,7 @@ enum **FillMode**: :ref:`🔗` 进度的样式（即填充进度条的部分）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_projection.rst b/classes/zh_CN/class_projection.rst index df73aaeba6..6123b3fa5d 100644 --- a/classes/zh_CN/class_projection.rst +++ b/classes/zh_CN/class_projection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Projection.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Projection.xml. .. _class_Projection: @@ -570,7 +570,7 @@ enum **Planes**: :ref:`🔗` :ref:`int` **get_pixels_per_meter**\ (\ for_pixel_width\: :ref:`int`\ ) |const| :ref:`🔗` -在该 **Projection** 被应用后，返回每米显示的具有给定像素宽度的像素数。 +返回 ``for_pixel_width`` 除以近平面上视口的宽度，单位为米，该宽度已应用 **Projection**\ 。 .. rst-class:: classref-item-separator @@ -744,6 +744,7 @@ enum **Planes**: :ref:`🔗` 索引按以下顺序排列：x、y、z、w。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_projectsettings.rst b/classes/zh_CN/class_projectsettings.rst index 1b4737a656..b5a00fee87 100644 --- a/classes/zh_CN/class_projectsettings.rst +++ b/classes/zh_CN/class_projectsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ProjectSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProjectSettings.xml. .. _class_ProjectSettings: @@ -48,6 +48,10 @@ ProjectSettings .. table:: :widths: auto + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility/general/accessibility_support` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility/general/updates_per_second` | ``60`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`animation/warnings/check_angle_interpolation_type_conflicting` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -105,6 +109,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/load_shell_environment` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | @@ -187,8 +193,6 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/confusable_local_usage` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``1`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/empty_file` | ``1`` | @@ -199,8 +203,6 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``1`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/get_node_default_without_onready` | ``2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``1`` | @@ -223,8 +225,6 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/onready_with_export` | ``2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``1`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/redundant_await` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/redundant_static_unload` | ``1`` | @@ -279,6 +279,10 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/settings/gdscript/always_track_call_stacks` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/settings/gdscript/always_track_local_variables` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/settings/physics_interpolation/enable_warnings` | ``true`` | @@ -317,23 +321,41 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/shader_language/warnings/unused_varying` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_agents_radius` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_agents_radius` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_obstacles_radius` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_obstacles_radius` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_obstacles_static` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_obstacles_static` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_agents_radius` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_obstacles_radius` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_obstacles_static` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color(1, 0.2, 0.1, 0.8)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -343,41 +365,69 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color(0, 0.6, 0.7, 0.42)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/agent_path_color` | ``Color(1, 0, 0, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/agent_path_color` | ``Color(1, 0, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debug/shapes/navigation/agent_path_point_size` | ``4.0`` | + | :ref:`float` | :ref:`debug/shapes/navigation/2d/agent_path_point_size` | ``4.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/edge_connection_color` | ``Color(1, 0, 1, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/edge_connection_color` | ``Color(1, 0, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_agent_paths` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_agent_paths` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_agent_paths_xray` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_edge_lines` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections_xray` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_geometry_face_random_color` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_link_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines_xray` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_geometry_face_random_color` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections_xray` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/agent_path_color` | ``Color(1, 0, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | + | :ref:`float` | :ref:`debug/shapes/navigation/3d/agent_path_point_size` | ``4.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/edge_connection_color` | ``Color(1, 0, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_agent_paths` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_agent_paths_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_connections` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_connections_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_lines` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_lines_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_geometry_face_random_color` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_link_connections` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_link_connections_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/paths/geometry_color` | ``Color(0.1, 1, 0.7, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -393,6 +443,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`display/display_server/driver.macos` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/display_server/driver.visionos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`display/display_server/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | @@ -433,6 +485,10 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/size/initial_screen` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/maximize_disabled` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/minimize_disabled` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/size/mode` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`display/window/size/no_focus` | ``false`` | @@ -483,12 +539,18 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editor/movie_writer/mix_rate` | ``48000`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editor/movie_writer/mjpeg_quality` | ``0.75`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`editor/movie_writer/movie_file` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editor/movie_writer/ogv/audio_quality` | ``0.5`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editor/movie_writer/ogv/encoding_speed` | ``4`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editor/movie_writer/ogv/keyframe_interval` | ``64`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editor/movie_writer/speaker_mode` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editor/movie_writer/video_quality` | ``0.75`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`editor/naming/default_signal_callback_name` | ``"_on_{node_name}_{signal_name}"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`editor/naming/default_signal_callback_to_self_name` | ``"_on_{signal_name}"`` | @@ -527,7 +589,7 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui/common/snap_controls_to_pixels` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui/common/swap_cancel_ok` | | + | :ref:`int` | :ref:`gui/common/swap_cancel_ok` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -563,8 +625,12 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_accept` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_accessibility_drag_and_drop` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_cancel` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_colorpicker_delete_preset` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_copy` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_cut` | | @@ -579,6 +645,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_filedialog_up_one_level` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_focus_mode` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_focus_next` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | @@ -587,6 +655,14 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_graph_duplicate` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_left` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_left.macos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_right` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_right.macos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_home` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_left` | | @@ -725,10 +801,14 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`input_devices/pen_tablet/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/disable_scroll_deadzone` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/android/enable_long_press_as_right_click` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/android/enable_pan_and_scale_gestures` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/override_volume_buttons` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`input_devices/pointing/android/rotary_input_scroll_axis` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | @@ -747,6 +827,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`internationalization/locale/include_text_server_data` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`internationalization/locale/line_breaking_strictness` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`internationalization/locale/test` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`internationalization/pseudolocalization/double_vowels` | ``false`` | @@ -1183,6 +1265,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`navigation/2d/default_link_connection_radius` | ``4.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/2d/merge_rasterizer_cell_scale` | ``1.0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/2d/use_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`navigation/3d/default_cell_height` | ``0.25`` | @@ -1213,6 +1297,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/world/map_use_async_iterations` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/world/region_use_async_iterations` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/limits/debugger/max_chars_per_second` | ``32768`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/limits/debugger/max_errors_per_second` | ``400`` | @@ -1243,7 +1329,7 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`physics/2d/run_on_separate_thread` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | + | :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.13962634`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1271,9 +1357,11 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`physics/3d/physics_interpolation/scene_traversal` | ``"DEFAULT"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`physics/3d/run_on_separate_thread` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/3d/sleep_threshold_angular` | ``0.139626`` | + | :ref:`float` | :ref:`physics/3d/sleep_threshold_angular` | ``0.13962634`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/3d/sleep_threshold_linear` | ``0.1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1299,13 +1387,13 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/jolt_physics_3d/collisions/active_edge_threshold` | ``0.872665`` | + | :ref:`float` | :ref:`physics/jolt_physics_3d/collisions/active_edge_threshold` | ``0.87266463`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/jolt_physics_3d/collisions/collision_margin_fraction` | ``0.08`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/jolt_physics_3d/joints/world_node` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/jolt_physics_3d/limits/max_angular_velocity` | ``47.1239`` | + | :ref:`float` | :ref:`physics/jolt_physics_3d/limits/max_angular_velocity` | ``47.12389`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/jolt_physics_3d/limits/max_bodies` | ``10240`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1331,11 +1419,9 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`physics/jolt_physics_3d/simulation/allow_sleep` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/jolt_physics_3d/simulation/areas_detect_static_bodies` | ``false`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/jolt_physics_3d/simulation/baumgarte_stabilization_factor` | ``0.2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold` | ``0.0349066`` | + | :ref:`float` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold` | ``0.034906585`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_distance_threshold` | ``0.001`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1385,6 +1471,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/anti_aliasing/quality/screen_space_aa` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/anti_aliasing/quality/smaa_edge_detection_threshold` | ``0.05`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_debanding` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_taa` | ``false`` | @@ -1597,6 +1685,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections.mobile` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/reflections/specular_occlusion/enabled` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method` | ``"forward_plus"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method.mobile` | ``"mobile"`` | @@ -1621,6 +1711,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/rendering_device/driver.macos` | ``"metal"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rendering/rendering_device/driver.visionos` | ``"metal"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/rendering_device/driver.windows` | ``"vulkan"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/rendering_device/fallback_to_d3d12` | ``true`` | @@ -1673,6 +1765,12 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/basis_universal/rdo_dict_size` | ``1024`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/textures/basis_universal/zstd_supercompression` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/basis_universal/zstd_supercompression_level` | ``6`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_filter` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_repeat` | ``0`` | @@ -1737,6 +1835,8 @@ ProjectSettings +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/extensions/hand_tracking_unobstructed_data_source` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`xr/openxr/extensions/render_model` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/form_factor` | ``"0"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/foveation_dynamic` | ``false`` | @@ -1762,43 +1862,45 @@ ProjectSettings .. table:: :widths: auto - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_property_info`\ (\ hint\: :ref:`Dictionary`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ name\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_global_class_list`\ (\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_order`\ (\ name\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting_with_override`\ (\ name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`globalize_path`\ (\ path\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`load_resource_pack`\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`localize_path`\ (\ path\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save`\ (\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_custom`\ (\ file\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_as_basic`\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_as_internal`\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_order`\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_restart_if_changed`\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_info`\ (\ hint\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ name\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_global_class_list`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_order`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting_with_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting_with_override_and_custom_features`\ (\ name\: :ref:`StringName`, features\: :ref:`PackedStringArray`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`globalize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`load_resource_pack`\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`localize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_custom`\ (\ file\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_basic`\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_internal`\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_order`\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_restart_if_changed`\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1826,6 +1928,38 @@ ProjectSettings 属性说明 -------- +.. _class_ProjectSettings_property_accessibility/general/accessibility_support: + +.. rst-class:: classref-property + +:ref:`int` **accessibility/general/accessibility_support** = ``0`` :ref:`🔗` + +无障碍支持模式： + +- **Auto**\ （\ ``0``\ ）：启用无障碍支持，但只会在辅助应用（屏幕阅读器、盲文显示器等）处于活动状态时才会处理无障碍信息的更新（默认）。 + +- **Always Active**\ （\ ``1``\ ）：启用无障碍支持，无论当前辅助应用的状态都会处理无障碍信息的处理。 + +- **Disabled**\ （\ ``2``\ ）：完全禁用无障碍支持。 + +\ **注意：**\ Accessibility Insights for Windows、Accessibility Inspector（macOS）、AT-SPI 浏览器（Linux/BSD）等无障碍调试工具不算作辅助应用。要使用这些工具测试应用，请使用 **Always Active**\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_accessibility/general/updates_per_second: + +.. rst-class:: classref-property + +:ref:`int` **accessibility/general/updates_per_second** = ``60`` :ref:`🔗` + +每秒无障碍信息的更新次数。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_animation/warnings/check_angle_interpolation_type_conflicting: .. rst-class:: classref-property @@ -2206,6 +2340,20 @@ ProjectSettings ---- +.. _class_ProjectSettings_property_application/run/load_shell_environment: + +.. rst-class:: classref-property + +:ref:`bool` **application/run/load_shell_environment** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则会加载默认的 Shell，将由 Shell 启动脚本设置的环境变量复制到应用程序环境中。 + +\ **注意：**\ 该设置仅在 macOS 上针对非沙盒应用程序实现。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_application/run/low_processor_mode: .. rst-class:: classref-property @@ -2354,7 +2502,7 @@ ProjectSettings 如果为 ``true``\ ，会允许麦克风输入。导出到 Android 和 iOS 时需要设置合适的权限。 -\ **注意：**\ 如果操作系统（根据该用户的隐私设置）阻止了对音频输入设备的访问，那么音频捕获只会返回静音。自 Windows 10 起，请确保在操作系统的隐私设置中允许应用对麦克风的访问。 +\ **注意：**\ 如果操作系统（根据该用户的隐私设置）阻止了对音频输入设备的访问，那么音频捕获只会返回静音。在 Windows 上，请确保在操作系统的隐私设置中允许应用对麦克风的访问。 .. rst-class:: classref-item-separator @@ -2400,7 +2548,7 @@ ProjectSettings 音频输出延迟可以使用 ``--audio-output-latency `` 命令行参数覆盖。 -\ **注意：**\ Android 以及 Windows 10 之前的所有版本都会忽略这个设置。 +\ **注意：**\ 在 Android 上会忽略这个设置。 .. rst-class:: classref-item-separator @@ -2440,7 +2588,7 @@ ProjectSettings 所有 :ref:`AudioStreamPlayer3D` 节点的声像效果的基本强度。可以使用 :ref:`AudioStreamPlayer3D.panning_strength` 在每个节点上进一步缩放声像强度。\ ``0.0`` 的值会完全禁用立体声声像，只保留音量衰减。如果声音恰好位于听者的左侧（或右侧），则 ``1.0`` 的值会使其中一个通道完全静音。 -\ ``0.5`` 的默认值是针对耳机进行调谐的。当使用扬声器时，可能会发现较低的值效果更好，因为与耳机相比，扬声器的立体声分离度较低。 +默认值 ``0.5`` 是针对耳机进行调谐的，对向声道的音量不会低于近侧声道音量的 50%。当使用扬声器时，你可能会发现将这个值设置得更高可以达到相同的效果，因为双耳都可以从各个扬声器听到声音。 .. rst-class:: classref-item-separator @@ -2512,7 +2660,7 @@ ProjectSettings :ref:`bool` **audio/general/text_to_speech** = ``false`` :ref:`🔗` -如果为 ``true``\ ，则启用文本转语音（Text-to-Speech，TTS）支持，见 :ref:`DisplayServer.tts_get_voices()` 和 :ref:`DisplayServer.tts_speak()`\ 。 +如果为 ``true``\ ，则会在启动时启用文本转语音（Text-to-Speech，TTS）支持，否则会在首次使用 TTS 方法时启用，见 :ref:`DisplayServer.tts_get_voices()` 和 :ref:`DisplayServer.tts_speak()`\ 。 \ **注意：**\ 启用 TTS 会增加空闲 CPU 的占用，影响睡眠模式，所以请在不需要 TTS 时考虑将其关闭。 @@ -2752,20 +2900,6 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/constant_used_as_function: - -.. rst-class:: classref-property - -:ref:`int` **debug/gdscript/warnings/constant_used_as_function** = ``1`` :ref:`🔗` - -**已弃用：** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. - -设为 ``warn`` 或 ``error`` 时，会在将常量当作函数使用时对应产生警告或错误。 - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_debug/gdscript/warnings/deprecated_keyword: .. rst-class:: classref-property @@ -2828,20 +2962,6 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/function_used_as_property: - -.. rst-class:: classref-property - -:ref:`int` **debug/gdscript/warnings/function_used_as_property** = ``1`` :ref:`🔗` - -**已弃用：** This warning is never produced. When a function is used as a property, a :ref:`Callable` is returned. - -设置为 ``warn`` 或 ``error`` 时，当函数作为属性使用时会分别产生一个警告或一个错误。 - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_debug/gdscript/warnings/get_node_default_without_onready: .. rst-class:: classref-property @@ -2884,9 +3004,9 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 :ref:`int` **debug/gdscript/warnings/inferred_declaration** = ``0`` :ref:`🔗` -设置为 ``warn`` 或 ``error`` 时，当变量、常量或参数具有隐式推断的静态类型时，分别产生警告或错误。 +When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. In GDScript, type inference is performed by declaring a variable with ``:=`` instead of ``=`` and leaving out the type specifier. For example, ``var x := 1`` will *infer* the :ref:`int` type, while ``var x: int = 1`` explicitly declares the variable as :ref:`int`. -\ **注意：**\ 如果你希望始终显式指定类型，则推荐该警告，\ *除了* :ref:`debug/gdscript/warnings/untyped_declaration`\ 。使 ``INFERRED_DECLARATION`` 警告级别高于 ``UNTYPED_DECLARATION`` 警告级别意义不大，且不被推荐。 +\ **Note:** This warning is recommended *in addition* to :ref:`debug/gdscript/warnings/untyped_declaration` if you want to always specify the type explicitly. Having ``INFERRED_DECLARATION`` warning level higher than ``UNTYPED_DECLARATION`` warning level makes little sense and is not recommended. .. rst-class:: classref-item-separator @@ -2976,20 +3096,6 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/property_used_as_function: - -.. rst-class:: classref-property - -:ref:`int` **debug/gdscript/warnings/property_used_as_function** = ``1`` :ref:`🔗` - -**已弃用：** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. - -设置为 ``warn`` 或 ``error`` 时，当像函数一样使用一个属性时，会分别产生一个警告或一个错误。 - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_debug/gdscript/warnings/redundant_await: .. rst-class:: classref-property @@ -3316,6 +3422,36 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- +.. _class_ProjectSettings_property_debug/settings/gdscript/always_track_call_stacks: + +.. rst-class:: classref-property + +:ref:`bool` **debug/settings/gdscript/always_track_call_stacks** = ``false`` :ref:`🔗` + +是否在发布构建中跟踪 GDScript 调用堆栈，从而使 :ref:`Engine.capture_script_backtraces()` 能够正常工作。 + +\ **注意：**\ 该设置在编辑器构建和调试构建中无效，始终会跟踪 GDScript 调用堆栈。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/settings/gdscript/always_track_local_variables: + +.. rst-class:: classref-property + +:ref:`bool` **debug/settings/gdscript/always_track_local_variables** = ``false`` :ref:`🔗` + +是否在包括导出构建在内的所有构建中跟踪 GDScript 局部变量，从而使 :ref:`Engine.capture_script_backtraces()` 在启用 ``include_variables`` 参数时能够捕获局部变量。 + +启用的代价是项目中每个编译的类中每个局部变量会多耗费约 50 字节的内存，大型项目可能总体达到多干 MiB。 + +\ **注意：**\ 该设置在编辑器构建和调试构建中无效，始终会跟踪 GDScript 局部变量。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_debug/settings/gdscript/max_call_stack: .. rst-class:: classref-property @@ -3546,11 +3682,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/agents_radius_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/agents_radius_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` 避障代理半径的颜色，在“调试”菜单中启用“显示避障”时可见。 @@ -3558,11 +3694,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_agents_radius: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_agents_radius: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_agents_radius** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_agents_radius** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示避障代理的半径。 @@ -3570,11 +3706,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_obstacles_radius: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_obstacles_radius: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_radius** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_obstacles_radius** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示避障障碍物的半径。 @@ -3582,11 +3718,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_obstacles_static: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_obstacles_static: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_static** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_obstacles_static** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示静态避障障碍物。 @@ -3594,11 +3730,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_radius_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_radius_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` 避障障碍物半径的颜色，在调试菜单中启用“显示避障”时可见。 @@ -3606,11 +3742,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_edge_pushin_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` 静态障碍物的顶点缠绕顺序会将代理推入时，障碍物边的颜色，在调试菜单中启用“显示避障”时可见。 @@ -3618,11 +3754,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_edge_pushout_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` 静态障碍物的顶点缠绕顺序会将代理推出时，障碍物边的颜色，在调试菜单中启用“显示避障”时可见。 @@ -3630,11 +3766,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_face_pushin_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_face_pushin_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` 静态障碍物的顶点缠绕顺序会将代理推入时，障碍物面的颜色，在调试菜单中启用“显示避障”时可见。 @@ -3642,11 +3778,119 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_face_pushout_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_face_pushout_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` + +静态障碍物的顶点缠绕顺序会将代理推出时，障碍物面的颜色，在调试菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/agents_radius_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` + +避障代理半径的颜色，在“调试”菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_agents_radius: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_agents_radius** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示避障代理的半径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_obstacles_radius: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_obstacles_radius** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示避障障碍物的半径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_obstacles_static: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_obstacles_static** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示避障”时显示静态避障障碍物。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_radius_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` + +避障障碍物半径的颜色，在调试菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` + +静态障碍物的顶点缠绕顺序会将代理推入时，障碍物边的颜色，在调试菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` + +静态障碍物的顶点缠绕顺序会将代理推出时，障碍物边的颜色，在调试菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_face_pushin_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` + +静态障碍物的顶点缠绕顺序会将代理推入时，障碍物面的颜色，在调试菜单中启用“显示避障”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_face_pushout_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` 静态障碍物的顶点缠绕顺序会将代理推出时，障碍物面的颜色，在调试菜单中启用“显示避障”时可见。 @@ -3702,11 +3946,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/agent_path_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/agent_path_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` 用于显示已启用的导航代理路径的颜色，代理启用调试时生效。 @@ -3714,11 +3958,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/agent_path_point_size: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/agent_path_point_size: .. rst-class:: classref-property -:ref:`float` **debug/shapes/navigation/agent_path_point_size** = ``4.0`` :ref:`🔗` +:ref:`float` **debug/shapes/navigation/2d/agent_path_point_size** = ``4.0`` :ref:`🔗` 栅格大小（像素），如果导航代理启用了调试，则会用于渲染该代理的路径点。 @@ -3726,11 +3970,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/edge_connection_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/edge_connection_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` 用于显示导航区域之间的边缘连接的颜色，在“调试”菜单中，启用“可见导航”时可见。 @@ -3738,11 +3982,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_agent_paths: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_agent_paths: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_agent_paths** = ``true`` :ref:`🔗` 如果处于启用状态，会在导航代理启用调试时显示其路径。 @@ -3750,23 +3994,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_agent_paths_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_edge_connections: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths_xray** = ``true`` :ref:`🔗` - -如果处于启用状态，会在导航代理启用调试时透过几何体显示其路径。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_connections: - -.. rst-class:: classref-property - -:ref:`bool` **debug/shapes/navigation/enable_edge_connections** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_edge_connections** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航地区之间的边缘连接。 @@ -3774,23 +4006,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_connections_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_edge_lines: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_connections_xray** = ``true`` :ref:`🔗` - -如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航地区之间的边缘连接。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_lines: - -.. rst-class:: classref-property - -:ref:`bool` **debug/shapes/navigation/enable_edge_lines** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_edge_lines** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航网格多边形的边缘。 @@ -3798,23 +4018,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_lines_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_geometry_face_random_color: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_lines_xray** = ``true`` :ref:`🔗` - -如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航网格多边形的边缘。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_geometry_face_random_color: - -.. rst-class:: classref-property - -:ref:`bool` **debug/shapes/navigation/enable_geometry_face_random_color** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_geometry_face_random_color** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示导航”时为每个导航网格多边形面使用随机颜色着色。 @@ -3822,11 +4030,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_link_connections: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_link_connections** = ``true`` :ref:`🔗` 如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航链接的连接。 @@ -3834,23 +4042,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_edge_color: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections_xray** = ``true`` :ref:`🔗` - -如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航链接的连接。 - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_edge_color: - -.. rst-class:: classref-property - -:ref:`Color` **debug/shapes/navigation/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` 用于显示已启用导航网格多边形边缘的颜色，在“调试”菜单中启用“显示导航”时可见。 @@ -3858,11 +4054,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_edge_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_edge_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` 用于显示已禁用导航网格多边形边缘的颜色，在“调试”菜单中启用“显示导航”时可见。 @@ -3870,11 +4066,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_face_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_face_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` 用于显示已启用导航网格多边形面的颜色，在“调试”菜单中启用“显示导航”时可见。 @@ -3882,11 +4078,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_face_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_face_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` 用于显示已禁用导航网格多边形面的颜色，在“调试”菜单中启用“显示导航”时可见。 @@ -3894,11 +4090,11 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/link_connection_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` 导航链接连接的颜色，在调试菜单中启用“显示导航”时可见。 @@ -3906,11 +4102,227 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/link_connection_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` + +被禁用的导航链接连接的颜色，在调试菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/agent_path_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` + +用于显示已启用的导航代理路径的颜色，代理启用调试时生效。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/agent_path_point_size: + +.. rst-class:: classref-property + +:ref:`float` **debug/shapes/navigation/3d/agent_path_point_size** = ``4.0`` :ref:`🔗` + +栅格大小（像素），如果导航代理启用了调试，则会用于渲染该代理的路径点。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/edge_connection_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` + +用于显示导航区域之间的边缘连接的颜色，在“调试”菜单中，启用“可见导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_agent_paths: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_agent_paths** = ``true`` :ref:`🔗` + +如果处于启用状态，会在导航代理启用调试时显示其路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_agent_paths_xray: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_agent_paths_xray** = ``true`` :ref:`🔗` + +如果处于启用状态，会在导航代理启用调试时透过几何体显示其路径。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_connections: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_connections** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航地区之间的边缘连接。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_connections_xray: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_connections_xray** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航地区之间的边缘连接。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_lines: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_lines** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航网格多边形的边缘。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_lines_xray: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_lines_xray** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航网格多边形的边缘。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_geometry_face_random_color: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_geometry_face_random_color** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时为每个导航网格多边形面使用随机颜色着色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_link_connections: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_link_connections** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时显示导航链接的连接。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_link_connections_xray: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_link_connections_xray** = ``true`` :ref:`🔗` + +如果处于启用状态，会在启用“调试”菜单中的“显示导航”时透过几何体显示导航链接的连接。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_edge_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` + +用于显示已启用导航网格多边形边缘的颜色，在“调试”菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_edge_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` + +用于显示已禁用导航网格多边形边缘的颜色，在“调试”菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_face_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` + +用于显示已启用导航网格多边形面的颜色，在“调试”菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_face_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` + +用于显示已禁用导航网格多边形面的颜色，在“调试”菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/link_connection_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` + +导航链接连接的颜色，在调试菜单中启用“显示导航”时可见。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/link_connection_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` 被禁用的导航链接连接的颜色，在调试菜单中启用“显示导航”时可见。 @@ -4002,6 +4414,18 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- +.. _class_ProjectSettings_property_display/display_server/driver.visionos: + +.. rst-class:: classref-property + +:ref:`String` **display/display_server/driver.visionos** :ref:`🔗` + +:ref:`display/display_server/driver` 在 visionOS 的覆盖项。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_display/display_server/driver.windows: .. rst-class:: classref-property @@ -4098,13 +4522,13 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 要使用的 Swappy 模式。可选项有： -- pipeline_forced_on：尝试遵循 :ref:`Engine.max_fps`\ 。管线始终启用。这是桌面 PC 的默认行为。 +- ``pipeline_forced_on``\ ：尝试遵循 :ref:`Engine.max_fps`\ 。管线始终启用。这是桌面 PC 的默认行为。 -- auto_fps_pipeline_forced_on：自动计算最大 FPS。实际的 max_fps 会在 0 到 :ref:`Engine.max_fps` 之间。虽然听起来很方便，但请注意，在找到足够稳定的最大值之前 Swappy 经常会降低最大 FPS。也就是说，如果你的游戏在 60hz 屏幕上运行在 40fps 和 60fps 之间，那么在一段时间后 Swappy 就会将最大 FPS 降低，让游戏精准地使用 30fps 渲染。 +- ``auto_fps_pipeline_forced_on``\ ：自动计算最大 FPS。实际的 max_fps 会在 ``0`` 到 :ref:`Engine.max_fps` 之间。虽然听起来很方便，但请注意，在找到足够稳定的最大值之前 Swappy 经常会降低最大 FPS。也就是说，如果你的游戏在 60hz 屏幕上运行在 40fps 和 60fps 之间，那么在一段时间后 Swappy 就会将最大 FPS 降低，让游戏精准地使用 30fps 渲染。 -- auto_fps_auto_pipeline：与 auto_fps_pipeline_forced_on 相同，但是如果 Swappy 检测到渲染极快（例如在 60hz 屏幕上耗时 < 8ms），那么 Swappy 就会禁用管线，尽可能降低输入延迟。这是默认行为。 +- ``auto_fps_auto_pipeline``\ ：与 ``auto_fps_pipeline_forced_on`` 相同，但是如果 Swappy 检测到渲染极快（例如在 60hz 屏幕上耗时小于 8ms），那么 Swappy 就会禁用管线，尽可能降低输入延迟。这是默认行为。 -\ **注意：**\ 如果 :ref:`Engine.max_fps` 为 0，那么就会把屏幕的刷新率当作实际的 max_fps（通常是 60hz、90hz、120hz 之类的，取决于设备型号和操作系统设置）。 +\ **注意：**\ 如果 :ref:`Engine.max_fps` 为 ``0``\ ，那么就会把屏幕的刷新率当作实际的最大 FPS（通常是 60hz、90hz、120hz 之类的，取决于设备型号和操作系统设置）。 .. rst-class:: classref-item-separator @@ -4276,6 +4700,30 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- +.. _class_ProjectSettings_property_display/window/size/maximize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **display/window/size/maximize_disabled** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则禁用主窗口的最大化按钮。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_display/window/size/minimize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **display/window/size/minimize_disabled** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则禁用主窗口的最小化按钮。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_display/window/size/mode: .. rst-class:: classref-property @@ -4346,6 +4794,8 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 \ **注意：**\ 如果 :ref:`display/window/per_pixel_transparency/allowed` 为 ``false``\ ，则这个设置项无效。 +\ **注意：**\ 这个设置在 Android 上无效，透明度仅通过 :ref:`display/window/per_pixel_transparency/allowed` 控制。 + .. rst-class:: classref-item-separator ---- @@ -4634,20 +5084,6 @@ Zstandard 的默认压缩级别。影响压缩的场景和资源。较高的级 ---- -.. _class_ProjectSettings_property_editor/movie_writer/mjpeg_quality: - -.. rst-class:: classref-property - -:ref:`float` **editor/movie_writer/mjpeg_quality** = ``0.75`` :ref:`🔗` - -JPEG 质量，将视频写入 AVI 文件时使用，介于 ``0.01`` 和 ``1.0``\ （含）之间。\ ``quality`` 值越高，输出效果越好看，但文件大小也越大。\ ``quality`` 的推荐值为 ``0.75`` 和 ``0.9`` 之间。即使质量为 ``1.0``\ ，JPEG 压缩仍然有损。 - -\ **注意：**\ 这不会影响音频质量和 PNG 图像序列的写入。 - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_editor/movie_writer/movie_file: .. rst-class:: classref-property @@ -4656,9 +5092,11 @@ JPEG 质量，将视频写入 AVI 文件时使用，介于 ``0.01`` 和 ``1.0``\ 影片的输出路径。文件扩展名决定要使用的 :ref:`MovieWriter`\ 。 -Godot 有两个内置的 :ref:`MovieWriter`\ ： +Godot 内置的 :ref:`MovieWriter` 有 3 个： -- AVI 容器，视频使用 MJPEG、音频未压缩（文件扩展名为 ``.avi``\ ）。有损压缩，文件大小中等，编码较快。有损压缩质量可以通过 :ref:`editor/movie_writer/mjpeg_quality` 调整。得到的文件可以使用大多数视频播放器查看，但必须转换成其他格式才能在 Web 或 Godot 的 :ref:`VideoStreamPlayer` 中播放。MJPEG 不支持透明度。AVI 输出目前有单文件 4 GB 的大小限制。 +- 使用 Theora 视频和 Vorbis 音频的 OVG 容器（文件扩展名为 ``.ogv``\ ）。有损压缩、文件大小中等、编码速度快。有损压缩质量可以通过修改 :ref:`editor/movie_writer/video_quality` 和 :ref:`editor/movie_writer/ogv/audio_quality` 来调整。生成的文件在 Godot 中可以使用 :ref:`VideoStreamPlayer` 查看，也可以使用大多数视频播放器查看，但是无法在网页浏览器中查看，因为它们不支持 Theora。 + +- 使用 MJPEG 视频和未压缩音频的 AVI 容器（文件扩展名为 ``.avi``\ ）。有损压缩、文件大小中等、编码速度较快。有损压缩质量可以通过修改 :ref:`editor/movie_writer/video_quality` 来调整。生成的文件可以使用大多数视频播放器查看，但如果要在 Web 上查看或者用 Godot 的 :ref:`VideoStreamPlayer` 查看，则必须先进行格式的转换。MJPEG 不支持透明度。AVI 输出的文件目前最多为 4 GB 大小。 - 视频使用 PNG 图像序列，音频使用 WAV（文件扩展名为 ``.png``\ ）。无损压缩，文件大小较大，编码较慢。旨在录制后使用 `FFmpeg `__ 等其他工具编码为视频文件。目前不支持透明度，即便将根视口设为透明也不行。 @@ -4670,6 +5108,44 @@ Godot 有两个内置的 :ref:`MovieWriter`\ ： ---- +.. _class_ProjectSettings_property_editor/movie_writer/ogv/audio_quality: + +.. rst-class:: classref-property + +:ref:`float` **editor/movie_writer/ogv/audio_quality** = ``0.5`` :ref:`🔗` + +将 Vorbis 音频写入文件时使用的音频编码质量，在 ``-0.1`` 和 ``1.0`` 之间（含两端）。\ ``quality`` 取值越高，输出的声音越好，但文件大小也越大。即便质量为 ``1.0``\ ，压缩也仍然是有损的。 + +\ **注意：**\ 不影响视频质量，视频质量 由 :ref:`editor/movie_writer/video_quality` 控制。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_editor/movie_writer/ogv/encoding_speed: + +.. rst-class:: classref-property + +:ref:`int` **editor/movie_writer/ogv/encoding_speed** = ``4`` :ref:`🔗` + +编码速度和压缩效率之间的权衡。速度 ``1`` 最慢，但压缩效果最佳。速度 ``4`` 最快，但压缩效果最差。该设置通常不会对视频质量产生显著影响。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_editor/movie_writer/ogv/keyframe_interval: + +.. rst-class:: classref-property + +:ref:`int` **editor/movie_writer/ogv/keyframe_interval** = ``64`` :ref:`🔗` + +强制关键帧使用特定的间隔（单位为帧数）。较高的取值可以一定程度改善压缩，但会导致跳转时延迟较高。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_editor/movie_writer/speaker_mode: .. rst-class:: classref-property @@ -4682,6 +5158,18 @@ Godot 有两个内置的 :ref:`MovieWriter`\ ： ---- +.. _class_ProjectSettings_property_editor/movie_writer/video_quality: + +.. rst-class:: classref-property + +:ref:`float` **editor/movie_writer/video_quality** = ``0.75`` :ref:`🔗` + +将 Theora 或 AVI（MJPEG）视频写入文件时使用的视频编码质量，在 ``0.0`` 和 ``1.0`` 之间（含两端）。\ ``quality`` 取值越高，输出的画质越好，但文件大小也越大。建议将 ``quality`` 设为 ``0.75`` 和 ``0.9`` 之间的值。即便质量为 ``1.0``\ ，压缩也仍然是有损的。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_editor/naming/default_signal_callback_name: .. rst-class:: classref-property @@ -4836,7 +5324,7 @@ Godot 有两个内置的 :ref:`MovieWriter`\ ： 如果为 ``true``\ ，扩展名为 ``.blend`` 的 Blender 3D 场景文件会通过转换为 glTF 2.0 来导入。 -需要在编辑器设置 ``filesystem/import/blender/blender_path`` 中，配置 Blender 可执行文件的路径。需要 Blender 3.0 或更高版本。 +需要在编辑器设置 :ref:`EditorSettings.filesystem/import/blender/blender_path` 中配置 Blender 可执行文件的路径。需要 Blender 3.0 或更高版本。 .. rst-class:: classref-item-separator @@ -4932,11 +5420,17 @@ Godot 有两个内置的 :ref:`MovieWriter`\ ： .. rst-class:: classref-property -:ref:`bool` **gui/common/swap_cancel_ok** :ref:`🔗` +:ref:`int` **gui/common/swap_cancel_ok** = ``0`` :ref:`🔗` -如果为 ``true`` ，则会在 Windows 上交换对话框中的\ **确定**\ 和\ **取消**\ 按钮，从而遵循界面规范。可以使用 :ref:`DisplayServer.get_swap_cancel_ok()` 查询运行时是否交换这两个按钮。 +如何在编辑器的 :ref:`AcceptDialog` 中放置“取消”和“确定”按钮。不同的平台有不同的标准行为，可以用这个设置来覆盖。 -\ **注意：**\ 由 :ref:`DisplayServer.dialog_show()` 等生成的原生对话框不受影响。 +- **Auto**\ （\ ``0``\ ）遵守平台约定：在 Windows、KDE、LXQt 上确定在前，在 macOS 和其他 Linux 桌面环境中取消在前。运行时可以使用 :ref:`DisplayServer.get_swap_cancel_ok()` 查询按钮是否发生交换。 + +- **Cancel First**\ （\ ``1``\ ）强制为取消、确定的顺序。 + +- **OK First**\ （\ ``2``\ ）强制为确定、取消的顺序。 + +\ **注意：**\ 不会影响原生对话框，例如 :ref:`DisplayServer.dialog_show()` 显示的对话框。 .. rst-class:: classref-item-separator @@ -4960,9 +5454,7 @@ Godot 有两个内置的 :ref:`MovieWriter`\ ： :ref:`bool` **gui/fonts/dynamic_fonts/use_oversampling** = ``true`` :ref:`🔗` -.. container:: contribute - - 该属性目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ +If set to ``true`` and :ref:`display/window/stretch/mode` is set to **"canvas_items"**, font and :ref:`DPITexture` oversampling is enabled in the main window. Use :ref:`Viewport.oversampling` to control oversampling in other viewports and windows. .. rst-class:: classref-item-separator @@ -5166,6 +5658,20 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input/ui_accessibility_drag_and_drop** :ref:`🔗` + +默认 :ref:`InputEventAction`\ ，用于不借助鼠标开始或结束拖放操作。 + +\ **注意：**\ 默认的 ``ui_*`` 动作是部分 :ref:`Control` 的内部逻辑所必需的，无法删除。但是可以修改分配给该动作的事件。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_cancel: .. rst-class:: classref-property @@ -5180,6 +5686,20 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input/ui_colorpicker_delete_preset** :ref:`🔗` + +默认 :ref:`InputEventAction`\ ，用于在 :ref:`ColorPicker` 中删除一个颜色预设。 + +\ **注意：**\ 默认的 ``ui_*`` 动作是部分 :ref:`Control` 的内部逻辑所必需的，无法删除。但是可以修改分配给该动作的事件。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_copy: .. rst-class:: classref-property @@ -5278,6 +5798,20 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input/ui_focus_mode** :ref:`🔗` + +默认 :ref:`InputEventAction`\ ，用于对 :ref:`TextEdit` 的 :ref:`input/ui_text_indent` 在“将键盘焦点移动到场景中的下一个 :ref:`Control` 上”和“输入 ``Tab`` 字符”之间进行切换。 + +\ **注意：**\ 默认的 ``ui_*`` 动作是部分 :ref:`Control` 的内部逻辑所必需的，无法删除。但是可以修改分配给该动作的事件。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_focus_next: .. rst-class:: classref-property @@ -5334,6 +5868,58 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input/ui_graph_follow_left** :ref:`🔗` + +默认 :ref:`InputEventAction`\ ，用于跟踪 :ref:`GraphNode` 输入端口的连接。 + +\ **注意：**\ 默认的 ``ui_*`` 动作是部分 :ref:`Control` 的内部逻辑所必需的，无法删除。但是可以修改分配给该动作的事件。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_left.macos: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_left.macos** :ref:`🔗` + +针对 macOS 的快捷键覆盖项，对应跟踪 :ref:`GraphNode` 输入端口的连接。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_right: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_right** :ref:`🔗` + +默认 :ref:`InputEventAction`\ ，用于跟踪 :ref:`GraphNode` 输出端口的连接。 + +\ **注意：**\ 默认的 ``ui_*`` 动作是部分 :ref:`Control` 的内部逻辑所必需的，无法删除。但是可以修改分配给该动作的事件。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_right.macos: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_right.macos** :ref:`🔗` + +针对 macOS 的快捷键覆盖项，对应跟踪 :ref:`GraphNode` 输出端口的连接。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_home: .. rst-class:: classref-property @@ -6290,6 +6876,18 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input_devices/pointing/android/disable_scroll_deadzone** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则会在 Android 上禁用滚动死区，从而让非常小的滚动动作也能够被注册。这可能会增加滚动灵敏度，但也可能导致由于轻微的手指移动而产生意外的滚动。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/android/enable_long_press_as_right_click: .. rst-class:: classref-property @@ -6314,6 +6912,18 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **input_devices/pointing/android/override_volume_buttons** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则在应用中使用系统音量按钮时禁用音量调节。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/android/rotary_input_scroll_axis: .. rst-class:: classref-property @@ -6428,6 +7038,28 @@ LCD 次像素布局，用于字体抗锯齿。见 :ref:`FontLCDSubpixelLayout` **internationalization/locale/line_breaking_strictness** = ``0`` :ref:`🔗` + +默认的断行规则严格程度。在语言代码后加上 ``@lb={auto,loose,normal,strict}`` 可以进行覆盖。 + +- **Auto**\ （\ ``0``\ ）- 严格度基于行的长度。 + +- **Loose**\ （\ ``1``\ ）- 严格度最低的断行规则集。常用于较短的行。 + +- **Normal**\ （\ ``2``\ ）- 最常见的断行规则集。 + +- **Strict**\ （\ ``3``\ ）- 最严格的断行规则集。 + +详见《\ `Line Breaking Strictness: the line-break property `__\ 》。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_internationalization/locale/test: .. rst-class:: classref-property @@ -9056,6 +9688,18 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 ---- +.. _class_ProjectSettings_property_navigation/2d/merge_rasterizer_cell_scale: + +.. rst-class:: classref-property + +:ref:`float` **navigation/2d/merge_rasterizer_cell_scale** = ``1.0`` :ref:`🔗` + +2D 导航地图的默认合并光栅化单元格缩放。见 :ref:`NavigationServer2D.map_set_merge_rasterizer_cell_scale()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_navigation/2d/use_edge_connections: .. rst-class:: classref-property @@ -9236,6 +9880,18 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 ---- +.. _class_ProjectSettings_property_navigation/world/region_use_async_iterations: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/world/region_use_async_iterations** = ``true`` :ref:`🔗` + +如果启用，导航区块的同步会在后台线程上进行异步处理。这样能够防止阻塞主线程，但是导航区块的更改都会增加额外的延迟。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_network/limits/debugger/max_chars_per_second: .. rst-class:: classref-property @@ -9482,7 +10138,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 .. rst-class:: classref-property -:ref:`float` **physics/2d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗` +:ref:`float` **physics/2d/sleep_threshold_angular** = ``0.13962634`` :ref:`🔗` 角速度的阈值，在该阈值以下的 2D 物理体将被视为不活动。见 :ref:`PhysicsServer2D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD`\ 。 @@ -9710,6 +10366,24 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 ---- +.. _class_ProjectSettings_property_physics/3d/physics_interpolation/scene_traversal: + +.. rst-class:: classref-property + +:ref:`String` **physics/3d/physics_interpolation/scene_traversal** = ``"DEFAULT"`` :ref:`🔗` + +启用物理插值时，遍历 3D 场景所使用的方法。 + +- ``DEFAULT``\ （默认）：默认优化方法。 + +- ``Legacy``\ （遗留）：以前的场景树遍历参考方法，较慢。 + +- ``Debug``\ （调试）：帧与帧之间交替使用 ``DEFAULT`` 和 ``Legacy`` 方法，提供日志信息（因此会较慢）。仅适用于调试；大多数情况下应使用 ``DEFAULT`` 方法。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_physics/3d/run_on_separate_thread: .. rst-class:: classref-property @@ -9728,7 +10402,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 .. rst-class:: classref-property -:ref:`float` **physics/3d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗` +:ref:`float` **physics/3d/sleep_threshold_angular** = ``0.13962634`` :ref:`🔗` 角速度的阈值，在该阈值以下的 3D 物理体将被视为不活动。见 :ref:`PhysicsServer3D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD`\ 。 @@ -9840,9 +10514,11 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 :ref:`int` **physics/common/max_physics_steps_per_frame** = ``8`` :ref:`🔗` -控制每个渲染帧所能模拟的最大物理迭代数。默认值经过调试，可以避免“死亡螺旋”，防止开销较大的物理仿真无限触发开销更大的仿真。不过如果渲染 FPS 小于 :ref:`physics/common/physics_ticks_per_second` 的 ``1 / max_physics_steps_per_frame``\ ，游戏看上去会是降速的。即便在物理计算中始终使用 ``delta`` 也一样会发生。要避免这种情况，如果增大了 :ref:`physics/common/physics_ticks_per_second`\ ，而且远大于默认值，那么建议将 :ref:`physics/common/max_physics_steps_per_frame` 也调大。 +控制每个渲染帧所能模拟的最大物理迭代数。默认值经过特调，可以避免帧率突然降得非常低、低于特定物理仿真次数的情况。造成的原因是物理引擎无法保持预期的仿真频率。此时帧率会开始下降，但引擎每个渲染帧最多只能进行特定次数的物理步骤仿真。从而逐渐形成恶性循环，帧率不断下降，直至一个非常低的帧率（通常是 1-2 FPS），这就是\ *物理死亡螺旋*\ 。 -\ **注意：**\ 这个属性只在项目启动时读取。要在运行时改变每帧模拟的最大物理步骤数，请改为设置 :ref:`Engine.max_physics_steps_per_frame`\ 。 +不过渲染 FPS 低于 :ref:`physics/common/physics_ticks_per_second` 的 ``1 / max_physics_steps_per_frame`` 就会给人降速的效果。即便在物理计算中一直使用 ``delta`` 也会如此。为了避免这种情况，如果已经将 :ref:`physics/common/physics_ticks_per_second` 提高到明显大于默认值，请增大 :ref:`physics/common/max_physics_steps_per_frame`\ 。 + +\ **注意：**\ 这个属性只会在项目启动时读取。要在运行时修改最大物理步骤仿真次数，请改为设置 :ref:`Engine.max_physics_steps_per_frame`\ 。 .. rst-class:: classref-item-separator @@ -9854,12 +10530,14 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 :ref:`bool` **physics/common/physics_interpolation** = ``false`` :ref:`🔗` -如果为 ``true``\ ，则渲染器将在最后两个变换之间插入物理对象的变换，这样即使物理刻度与渲染帧不一致，也可以看到平滑的运动。另见 :ref:`Node.physics_interpolation_mode` 和 :ref:`Node.reset_physics_interpolation()`\ 。 +如果为 ``true``\ ，则渲染器将在最后两个变换之间插入对象的变换（无论该对象为物理对象还是非物理对象），这样即使物理刻度与渲染帧不一致，也可以看到平滑的运动。另见 :ref:`Node.reset_physics_interpolation()`\ 。 -\ **注意：**\ 如果为 ``true``\ ，则应通过将 :ref:`physics/common/physics_jitter_fix` 设置为 ``0.0`` 来禁用物理抖动修复。 +\ **注意：**\ 尽管这是全局设置，仍可使用 :ref:`Node.physics_interpolation_mode` 对 :ref:`SceneTree` 中的分支进行精细的控制。 \ **注意：**\ 该属性仅在项目启动时读取。要在运行时切换物理插值，请改为设置 :ref:`SceneTree.physics_interpolation`\ 。 +\ **注意：**\ 如果 :ref:`physics/common/physics_interpolation` 为 ``true``\ ，则会自动禁用 :ref:`physics/common/physics_jitter_fix` 属性，因为这两个方法不兼容。 + .. rst-class:: classref-item-separator ---- @@ -9902,7 +10580,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 .. rst-class:: classref-property -:ref:`float` **physics/jolt_physics_3d/collisions/active_edge_threshold** = ``0.872665`` :ref:`🔗` +:ref:`float` **physics/jolt_physics_3d/collisions/active_edge_threshold** = ``0.87266463`` :ref:`🔗` 在 :ref:`ConcavePolygonShape3D` 或 :ref:`HeightMapShape3D` 中两个相邻三角形之间的最大角度（单位为弧度），超过该角度的边被视为不活跃。 @@ -9914,8 +10592,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 启用 Jolt 的增强内部边缘移除功能时该设置不适用，该功能优先。 -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -9932,8 +10608,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 将该值设得过于接近 ``0.0`` 可能也会对凸形状碰撞检测的精度产生负面影响。 -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -9956,7 +10630,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 .. rst-class:: classref-property -:ref:`float` **physics/jolt_physics_3d/limits/max_angular_velocity** = ``47.1239`` :ref:`🔗` +:ref:`float` **physics/jolt_physics_3d/limits/max_angular_velocity** = ``47.12389`` :ref:`🔗` :ref:`RigidBody3D` 能够达到的最大角速度，单位为弧度每秒。 @@ -10056,8 +10730,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 受影响的方法有 :ref:`CharacterBody3D.move_and_slide()`\ 、\ :ref:`PhysicsBody3D.move_and_collide()`\ 、\ :ref:`PhysicsBody3D.test_move()`\ 、\ :ref:`PhysicsServer3D.body_test_motion()`\ 。 -\ **注意：**\ 该设置在应用程序的生命周期中只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -10072,8 +10744,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 受影响的方法有 :ref:`CharacterBody3D.move_and_slide()`\ 、\ :ref:`PhysicsBody3D.move_and_collide()`\ 、\ :ref:`PhysicsBody3D.test_move()`\ 、\ :ref:`PhysicsServer3D.body_test_motion()`\ 。 -\ **注意：**\ 该设置在应用程序的生命周期中只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -10088,8 +10758,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ :ref:`CharacterBody3D.move_and_slide()`\ 、\ :ref:`PhysicsBody3D.move_and_collide()`\ 、\ :ref:`PhysicsBody3D.test_move()`\ 、\ :ref:`PhysicsServer3D.body_test_motion()` 等方法均会受到影响。 -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -10104,8 +10772,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 启用该设置会使 Jolt 对 :ref:`ConcavePolygonShape3D` 的内存使用增加约 25%。 -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -10122,8 +10788,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 \ **注意：**\ 启用该设置可能导致从结果中完全剔除某些形状，但每个物体至少会得到一个交点。 -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 - .. rst-class:: classref-item-separator ---- @@ -10140,24 +10804,6 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 ---- -.. _class_ProjectSettings_property_physics/jolt_physics_3d/simulation/areas_detect_static_bodies: - -.. rst-class:: classref-property - -:ref:`bool` **physics/jolt_physics_3d/simulation/areas_detect_static_bodies** = ``false`` :ref:`🔗` - -如果为 ``true``\ ，则 :ref:`Area3D` 节点能够检测与 :ref:`StaticBody3D` 节点的重叠。 - -\ **注意：**\ 启用该设置可能会带来较高的 CPU 和内存开销，特别是当允许许多/大型 :ref:`Area3D` 与复杂的静态几何体（如 :ref:`ConcavePolygonShape3D` 或 :ref:`HeightMapShape3D`\ ）重叠时。强烈建议设置碰撞层和掩码，使得只有少量小型 :ref:`Area3D` 节点能够检测到 :ref:`StaticBody3D` 节点。 - -\ **注意：**\ 同样适用于与使用 :ref:`RigidBody3D.FREEZE_MODE_STATIC` 冻结的 :ref:`RigidBody3D` 的重叠。 - -\ **注意：**\ 检测与 :ref:`AnimatableBody3D` 的重叠不需要此设置，它虽然继承自 :ref:`StaticBody3D`\ ，但是一种运动学物体。 - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_physics/jolt_physics_3d/simulation/baumgarte_stabilization_factor: .. rst-class:: classref-property @@ -10176,7 +10822,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 .. rst-class:: classref-property -:ref:`float` **physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold** = ``0.0349066`` :ref:`🔗` +:ref:`float` **physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold** = ``0.034906585`` :ref:`🔗` 一对物体可以移动的最大相对角度，移动后仍然可以重用上一个物理步骤的碰撞结果，单位为弧度。 @@ -10214,9 +10860,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 :ref:`float` **physics/jolt_physics_3d/simulation/bounce_velocity_threshold** = ``1.0`` :ref:`🔗` -发生弹性碰撞所需的最小速度（单位为米每秒）。 - -\ **注意：**\ 该设置在应用程序的生命周期内只会读取一次。 +发生弹性碰撞所需的最小速度，单位为米每秒。 .. rst-class:: classref-item-separator @@ -10380,7 +11024,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 在批处理绘制调用时，2D 渲染器缓存的 Uniform 集的最大数量。 -\ **注意：**\ 如果项目每帧都会使用大量不同的精灵纹理，增加该值可能会带来好处。 +\ **注意：**\ 如果项目每帧都会渲染大量不同的精灵纹理，增加该值会提升性能。 .. rst-class:: classref-item-separator @@ -10514,17 +11158,31 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 ---- +.. _class_ProjectSettings_property_rendering/anti_aliasing/quality/smaa_edge_detection_threshold: + +.. rst-class:: classref-property + +:ref:`float` **rendering/anti_aliasing/quality/smaa_edge_detection_threshold** = ``0.05`` :ref:`🔗` + +设置使用 SMAA 抗锯齿时对边界的敏感度。取值越低捕获的边界越多，但潜在的性能开销也越高。 + +\ **注意：**\ 该属性仅在项目启动时读取，目前没有办法在运行时更改。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding: .. rst-class:: classref-property :ref:`bool` **rendering/anti_aliasing/quality/use_debanding** = ``false`` :ref:`🔗` -如果为 ``true``\ ，则使用一个快速的后期处理滤镜使条带在 3D 中不那么明显。除非 :ref:`Environment.background_mode` 为 :ref:`Environment.BG_CANVAS`\ ，否则 2D 渲染\ *不会*\ 受到去条带的影响。 +如果为 ``true``\ ，则会使用快速后期处理滤镜使条带现象不那么明显。如果 :ref:`rendering/viewport/hdr_2d` 为 ``false``\ ，则 2D 渲染\ *不会*\ 受到去条带处理的影响，除非 :ref:`Environment.background_mode` 为 :ref:`Environment.BG_CANVAS`\ 。如果 :ref:`rendering/viewport/hdr_2d` 为 ``true``\ ，则去条带处理会影响所有 2D 和 3D 渲染，包括画布项目。 -在某些情况下，去条带可能会引入稍微明显的抖动图案。建议只在实际需要时才启用去条带，因为抖动图案会使无损压缩的屏幕截图变大。 +在某些情况下，去条带处理可能会引入轻微可见的抖动图案。建议仅在实际需要时启用去条带处理，因为抖动图案会使无损压缩的截图变大。 -\ **注意：**\ 该属性仅在项目启动时读取。要在运行时设置去条带，请改为在根 :ref:`Viewport` 上设置 :ref:`Viewport.use_debanding` 或使用 :ref:`RenderingServer.viewport_set_use_debanding()`\ 。 +\ **注意：**\ 该属性仅在项目启动时读取。要在运行时设置去条带，请改为在根 :ref:`Viewport` 上设置 :ref:`Viewport.use_debanding`\ ，或使用 :ref:`RenderingServer.viewport_set_use_debanding()`\ 。 .. rst-class:: classref-item-separator @@ -10696,6 +11354,8 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 设置辉光效果在复制到屏幕之前的放大方式。Linear（线性）更快，但看起来棱角分明。Bicubic（双线性）更慢，但看起来比较平滑。 +\ **注意：**\ :ref:`rendering/environment/glow/upscale_mode` 仅在使用 Forward+ 和 Mobile 渲染方法时有效，Compatibility 使用的辉光实现不同。 + .. rst-class:: classref-item-separator ---- @@ -11068,7 +11728,7 @@ Godot 使用一个消息队列来延迟一些函数调用。如果你的空间 - ``opengl3``\ （默认），原生驱动的 OpenGL 3.3。如果启用了 :ref:`rendering/gl_compatibility/fallback_to_native`\ ，则会在将 ANGLE 配置为首选驱动但不支持时作为回退使用。 -- ``opengl3_es``\ ，基于原生 Direct3D 11 驱动使用 ANGLE 兼容层的 OpenGL ES 3.0。如果启用了 :ref:`rendering/gl_compatibility/fallback_to_angle`\ ，则会在不支持 OpenGL 3.3 时作为回退使用。默认情况下，\ :ref:`rendering/gl_compatibility/force_angle_on_devices` 中列出的设备会使用 ANGLE 作为默认驱动。 +- ``opengl3_angle``\ ，基于原生 Direct3D 11 驱动使用 ANGLE 兼容层的 OpenGL ES 3.0。如果启用了 :ref:`rendering/gl_compatibility/fallback_to_angle`\ ，则会在不支持 OpenGL 3.3 时作为回退使用。默认情况下，\ :ref:`rendering/gl_compatibility/force_angle_on_devices` 中列出的设备会使用 ANGLE 作为默认驱动。 .. rst-class:: classref-item-separator @@ -11526,7 +12186,7 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv** = ``2`` :ref:`🔗` -阴影贴图的细分象限大小。请参阅阴影映射文档。 +阴影图集中第一象限的细分量。详见\ `文档 <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__\ 。 .. rst-class:: classref-item-separator @@ -11538,7 +12198,7 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv** = ``2`` :ref:`🔗` -阴影贴图的细分象限大小。请参阅阴影映射文档。 +阴影图集中第二象限的细分量。详见\ `文档 <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__\ 。 .. rst-class:: classref-item-separator @@ -11550,7 +12210,7 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv** = ``3`` :ref:`🔗` -阴影贴图的细分象限大小。请参阅阴影映射文档。 +阴影图集中第三象限的细分量。详见\ `文档 <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__\ 。 .. rst-class:: classref-item-separator @@ -11562,7 +12222,7 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv** = ``4`` :ref:`🔗` -阴影贴图的细分象限大小。请参阅阴影映射文档。 +阴影图集中第四象限的细分量。详见\ `文档 <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__\ 。 .. rst-class:: classref-item-separator @@ -11574,7 +12234,7 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size** = ``4096`` :ref:`🔗` -阴影图集的大小（用于 OmniLight 和 SpotLight）。请参阅文档。 +:ref:`OmniLight3D` 和 :ref:`SpotLight3D` 节点所使用的阴影图集的大小。详见\ `文档 <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__\ 。 .. rst-class:: classref-item-separator @@ -11922,6 +12582,8 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 如果为 ``true``\ ，则使用纹理数组而不是 mipmap，用于反射探针和全景背景（天空）。这减少了反射上的抖动噪声和放大伪影，但计算速度明显变慢，并且使用了 :ref:`rendering/reflections/sky_reflections/roughness_layers` 倍的内存。 +\ **注意：**\ 由于驱动问题，纹理数组反射在 Intel GPU 的 macOS 上始终禁用。 + .. rst-class:: classref-item-separator ---- @@ -11938,6 +12600,18 @@ OIDN 将在可用时使用 GPU 加速。与使用计算着色器进行加速的 ---- +.. _class_ProjectSettings_property_rendering/reflections/specular_occlusion/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **rendering/reflections/specular_occlusion/enabled** = ``true`` :ref:`🔗` + +如果为 ``true``\ ，则会减少基于环境光的反射。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/renderer/rendering_method: .. rst-class:: classref-property @@ -12138,6 +12812,22 @@ Direct3D 12 渲染驱动每帧所使用的采样器描述符堆中的条目数 ---- +.. _class_ProjectSettings_property_rendering/rendering_device/driver.visionos: + +.. rst-class:: classref-property + +:ref:`String` **rendering/rendering_device/driver.visionos** = ``"metal"`` :ref:`🔗` + +:ref:`rendering/rendering_device/driver` 针对 visionOS 的覆盖项。 + +仅支持一个选项： + +- ``metal``\ （默认），使用原生驱动程序的 Metal。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/rendering_device/driver.windows: .. rst-class:: classref-property @@ -12178,7 +12868,7 @@ Direct3D 12 渲染驱动每帧所使用的采样器描述符堆中的条目数 如果为 ``true``\ ，则 Forward 渲染器在不支持 Direct3D 12、Metal、Vulkan 时会回退到 OpenGL 3。 -\ **注意：**\ 该设置仅在 Windows、Android、macOS、iOS、Linux/X11 上实现。 +\ **注意：**\ 该设置在 Windows、Android、macOS、iOS、Linux/X11 上实现。 .. rst-class:: classref-item-separator @@ -12192,7 +12882,7 @@ Direct3D 12 渲染驱动每帧所使用的采样器描述符堆中的条目数 如果为 ``true``\ ，则 Forward 渲染器在不支持 Direct3D 12（在 Windows 上）或 Metal（在 macOS x86_64 上）时会回退到 Vulkan。如果编译时禁用了 Direct3D 12（Windows）或 Metal（macOS）驱动程序支持，则会始终尝试回退，不考虑该设置。 -\ **注意：**\ 该设置仅在 Windows 和 macOS 上实现。 +\ **注意：**\ 该设置在 Windows 和 macOS 上实现。 .. rst-class:: classref-item-separator @@ -12506,6 +13196,44 @@ Direct3D 12 渲染驱动每帧所使用的采样器描述符堆中的条目数 ---- +.. _class_ProjectSettings_property_rendering/textures/basis_universal/rdo_dict_size: + +.. rst-class:: classref-property + +:ref:`int` **rendering/textures/basis_universal/rdo_dict_size** = ``1024`` :ref:`🔗` + +率-失真优化（Rate-Distortion Optimization、RDO）的字典大小，将纹理导入为 Basis Universal 且启用 RDO 时使用，范围为 ``64`` 到 ``65536`` 之间。值越高，文件大小减小得越多，但会显著增加编码时间。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/textures/basis_universal/zstd_supercompression: + +.. rst-class:: classref-property + +:ref:`bool` **rendering/textures/basis_universal/zstd_supercompression** = ``true`` :ref:`🔗` + +如果为 ``true``\ ，则会启用 Zstandard 超压缩，在以 Basis Universal 形式导入纹理时减小文件大小。 + +\ **注意：**\ Basis Universal 纹理需要压缩才能利用更小的文件尺寸，否则和 VRAM 压缩纹理一样大。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/textures/basis_universal/zstd_supercompression_level: + +.. rst-class:: classref-property + +:ref:`int` **rendering/textures/basis_universal/zstd_supercompression_level** = ``6`` :ref:`🔗` + +指定 Basis Universal Zstandard 超压缩的压缩级别，范围从 ``1`` 到 ``22``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/textures/canvas_textures/default_texture_filter: .. rst-class:: classref-property @@ -12708,11 +13436,13 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 :ref:`bool` **rendering/viewport/hdr_2d** = ``false`` :ref:`🔗` -如果为 ``true``\ ，则在根视口上启用 :ref:`Viewport.use_hdr_2d`\ 。2D 渲染将使用与 3D 帧缓冲的位深度相匹配的高动态范围（HDR）格式的帧缓冲。使用 Forward+ 渲染器时为 ``RGBA16`` 帧缓冲，使用 Mobile 渲染器时为 ``RGB10_A2`` 帧缓冲。此外，2D 渲染将在线性色彩空间中进行，并将在传输到屏幕之前立即转换到 sRGB 空间。实际上，这意味着 Viewport 的最终结果不会被限制在 ``0-1`` 范围内，无需调整色彩空间即可在 3D 渲染中使用。这使得 2D 渲染能够利用需要高动态范围的效果（例如 2D 辉光），并显著改善需要高度详细渐变的效果的外观。 +If ``true``, enables :ref:`Viewport.use_hdr_2d` on the root viewport. 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility renderer, this will be an ``RGBA16`` framebuffer. When using the Mobile renderer, it will be an ``RGB10_A2`` framebuffer. -\ **注意：**\ 使用 Compatibility 渲染器时该设置不起作用，出于性能原因，该渲染器始终在低动态范围内渲染。 +Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). -\ **注意：**\ 该属性仅在项目启动时读取。要在运行时开关 HDR 2D，请在根 :ref:`Viewport` 上设置 :ref:`Viewport.use_hdr_2d`\ 。 +Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. + +\ **Note:** This property is only read when the project starts. To toggle HDR 2D at runtime, set :ref:`Viewport.use_hdr_2d` on the root :ref:`Viewport`. .. rst-class:: classref-item-separator @@ -12787,7 +13517,7 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 :ref:`int` **threading/worker_pool/max_threads** = ``-1`` :ref:`🔗` -:ref:`WorkerThreadPool` 所使用的最大线程数。\ ``-1`` 表示无限制。 +:ref:`WorkerThreadPool` 所使用的最大线程数。\ ``-1`` 在 Web 上表示 ``1``\ ，在其他平台表示可用的\ *逻辑* CPU 内核数（见 :ref:`OS.get_processor_count()`\ ）。 .. rst-class:: classref-item-separator @@ -12943,6 +13673,20 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 ---- +.. _class_ProjectSettings_property_xr/openxr/extensions/render_model: + +.. rst-class:: classref-property + +:ref:`bool` **xr/openxr/extensions/render_model** = ``false`` :ref:`🔗` + +如果为 ``true``\ ，则在渲染模型扩展可用时启用该扩展。 + +\ **注意：**\ 与核心 OpenXR 渲染模型扩展相关，与供应商渲染模型扩展无关。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_xr/openxr/form_factor: .. rst-class:: classref-property @@ -12963,8 +13707,6 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 如果为 ``true`` 并且支持注视点，将根据帧速率自动调整注视点级别，直至达到 :ref:`xr/openxr/foveation_level` 上设置的级别。 -\ **注意：**\ 仅适用于兼容性渲染方法。 - .. rst-class:: classref-item-separator ---- @@ -12977,7 +13719,7 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 应用的注视点级别（如果支持）：0 = 关闭、1 = 低、2 = 中、3 = 高。 -\ **注意：**\ 仅适用于兼容性渲染方法。在 Android 以外的平台上，如果启用了 :ref:`rendering/anti_aliasing/quality/msaa_3d`\ ，则该功能将被禁用。 +\ **注意：**\ 在 Android 以外的平台上，如果启用了 :ref:`rendering/anti_aliasing/quality/msaa_3d`\ ，则该功能将被禁用。 .. rst-class:: classref-item-separator @@ -13068,32 +13810,34 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 .. code-tab:: gdscript ProjectSettings.set("category/property_name", 0) - + var property_info = { "name": "category/property_name", "type": TYPE_INT, "hint": PROPERTY_HINT_ENUM, "hint_string": "one,two,three" } - + ProjectSettings.add_property_info(property_info) .. code-tab:: csharp ProjectSettings.Singleton.Set("category/property_name", 0); - + var propertyInfo = new Godot.Collections.Dictionary { - {"name", "category/propertyName"}, - {"type", (int)Variant.Type.Int}, - {"hint", (int)PropertyHint.Enum}, - {"hint_string", "one,two,three"}, + { "name", "category/propertyName" }, + { "type", (int)Variant.Type.Int }, + { "hint", (int)PropertyHint.Enum }, + { "hint_string", "one,two,three" }, }; - + ProjectSettings.AddPropertyInfo(propertyInfo); +\ **注意：**\ 不支持设置属性的 ``"usage"``\ 。请使用 :ref:`set_as_basic()`\ 、\ :ref:`set_restart_if_changed()`\ 、\ :ref:`set_as_internal()` 修改用途标志。 + .. rst-class:: classref-item-separator ---- @@ -13171,6 +13915,8 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 \ **注意：**\ 这个方法不会自动考虑可能的特性覆盖项。如需无缝处理，请使用 :ref:`get_setting_with_override()`\ 。 +另见 :ref:`has_setting()`\ ，用于检查设置是否存在。 + .. rst-class:: classref-item-separator ---- @@ -13198,6 +13944,18 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_method_get_setting_with_override_and_custom_features: + +.. rst-class:: classref-method + +:ref:`Variant` **get_setting_with_override_and_custom_features**\ (\ name\: :ref:`StringName`, features\: :ref:`PackedStringArray`\ ) |const| :ref:`🔗` + +与 :ref:`get_setting_with_override()` 类似，但是会应用特性标签覆盖而不是使用当前操作系统的特性。 + .. rst-class:: classref-item-separator ---- @@ -13236,7 +13994,9 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 :ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` -配置值存在时返回 ``true``\ 。 +如果某个配置的值存在，则返回 ``true``\ 。 + +\ **注意：**\ 为了能够被检测到，自定义设置需要通过 :ref:`set_setting()` 定义或在 ``project.godot`` 文件中存在。使用 :ref:`set_initial_value()` 时尤为如此。 .. rst-class:: classref-item-separator @@ -13328,7 +14088,22 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 |void| **set_initial_value**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` -设置指定设置的初始值。这是属性恢复到的值。 +设置指定设置的初始值。这是还原该设置时所使用的值。调用该方法前应该已存在该设置。请注意，不会保存当前值与默认值相同的项目设置，编写代码时请务必考虑这一点。 + +:: + + extends EditorPlugin + + const SETTING_NAME = "addons/my_setting" + const SETTING_DEFAULT = 10.0 + + func _enter_tree(): + if not ProjectSettings.has_setting(SETTING_NAME): + ProjectSettings.set_setting(SETTING_NAME, SETTING_DEFAULT) + + ProjectSettings.set_initial_value(SETTING_NAME, SETTING_DEFAULT) + +如果使用 :ref:`EditorPlugin` 定义了项目设置，但又想要在运行的项目中使用这一设置，则需要在运行时执行类似的代码。 .. rst-class:: classref-item-separator @@ -13384,6 +14159,7 @@ WebP 的默认压缩方法。影响有损和无损 WebP。较高的值会以压 也可以用来擦除自定义项目设置。方法是将设置项的值设置为 ``null``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_propertytweener.rst b/classes/zh_CN/class_propertytweener.rst index b653d7b0cc..d6bc7e5ade 100644 --- a/classes/zh_CN/class_propertytweener.rst +++ b/classes/zh_CN/class_propertytweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/PropertyTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PropertyTweener.xml. .. _class_PropertyTweener: @@ -157,12 +157,12 @@ PropertyTweener .. code-tab:: gdscript @export var curve: Curve - + func _ready(): var tween = create_tween() # 使用自定义曲线进行插值。 tween.tween_property(self, "position:x", 300, 1).as_relative().set_custom_interpolator(tween_curve) - + func tween_curve(v): return curve.sample_baked(v) @@ -170,7 +170,7 @@ PropertyTweener [Export] public Curve Curve { get; set; } - + public override void _Ready() { Tween tween = CreateTween(); @@ -178,7 +178,7 @@ PropertyTweener Callable tweenCurveCallable = Callable.From(TweenCurve); tween.TweenProperty(this, "position:x", 300.0f, 1.0f).AsRelative().SetCustomInterpolator(tweenCurveCallable); } - + private float TweenCurve(float value) { return Curve.SampleBaked(value); @@ -223,6 +223,7 @@ PropertyTweener 设置所使用的过渡类型 :ref:`TransitionType`\ 。如果没有设置，则使用包含这个 Tweener 的 :ref:`Tween` 的默认过渡类型。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_quadmesh.rst b/classes/zh_CN/class_quadmesh.rst index 7a38bd6a28..0880398416 100644 --- a/classes/zh_CN/class_quadmesh.rst +++ b/classes/zh_CN/class_quadmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/QuadMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/QuadMesh.xml. .. _class_QuadMesh: @@ -45,6 +45,7 @@ QuadMesh +------------------------------------------------+-------------+-------------------------------------------------------------------------------+ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_quadoccluder3d.rst b/classes/zh_CN/class_quadoccluder3d.rst index 18d402eb87..700eab6803 100644 --- a/classes/zh_CN/class_quadoccluder3d.rst +++ b/classes/zh_CN/class_quadoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/QuadOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/QuadOccluder3D.xml. .. _class_QuadOccluder3D: @@ -65,6 +65,7 @@ QuadOccluder3D 该四边形的大小，使用 3D 单位。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_quaternion.rst b/classes/zh_CN/class_quaternion.rst index c5bfe9872b..91db53e171 100644 --- a/classes/zh_CN/class_quaternion.rst +++ b/classes/zh_CN/class_quaternion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Quaternion.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Quaternion.xml. .. _class_Quaternion: @@ -750,6 +750,7 @@ Quaternion 返回该 **Quaternion** 的负值。这与将所有分量乘以 ``-1`` 相同。这个操作得到的是代表相同旋转的四元数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_randomnumbergenerator.rst b/classes/zh_CN/class_randomnumbergenerator.rst index af938db3af..cb428851b3 100644 --- a/classes/zh_CN/class_randomnumbergenerator.rst +++ b/classes/zh_CN/class_randomnumbergenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RandomNumberGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RandomNumberGenerator.xml. .. _class_RandomNumberGenerator: @@ -138,7 +138,7 @@ RandomNumberGenerator 是一个用于生成伪随机数的类。它目前使用 \ **注意：**\ 不要将状态设置为任意值，因为随机数生成器要求状态具有某些特性才能正常运行。它应该只设置为来自状态属性本身的值。要使用任意输入初始化随机数生成器，请改用 :ref:`seed`\ 。 -\ **注意：**\ 该属性的默认值是伪随机的，会在调用 :ref:`randomize()` 时改变。文档中记录的 ``0`` 是占位符，不是实际的默认种子。 +\ **注意：**\ 该属性的默认值是伪随机的，会在调用 :ref:`randomize()` 时改变。文档中记录的 ``0`` 是占位符，不是实际的默认状态。 .. rst-class:: classref-section-separator @@ -163,10 +163,10 @@ RandomNumberGenerator 是一个用于生成伪随机数的类。它目前使用 .. code-tab:: gdscript var rng = RandomNumberGenerator.new() - + var my_array = ["one", "two", "three", "four"] var weights = PackedFloat32Array([0.5, 1, 1, 2]) - + # 输出 `my_array` 中的四个元素之一。 # 更有可能输出 “four”，而不太可能输出 “one”。 print(my_array[rng.rand_weighted(weights)]) @@ -248,6 +248,7 @@ RandomNumberGenerator 是一个用于生成伪随机数的类。它目前使用 为这个 **RandomNumberGenerator** 实例设置基于时间的种子。与 :ref:`@GlobalScope` 随机数生成函数不同，不同的 **RandomNumberGenerator** 实例可以使用不同的种子。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_range.rst b/classes/zh_CN/class_range.rst index 6605e823d1..6f7c342522 100644 --- a/classes/zh_CN/class_range.rst +++ b/classes/zh_CN/class_range.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Range.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Range.xml. .. _class_Range: @@ -158,7 +158,7 @@ Range 是代表特定范围内数字的控件的抽象基类，能够对步长 : - |void| **set_exp_ratio**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_ratio_exp**\ (\ ) -如果为 ``true``\ ，并且 :ref:`min_value` 大于 0，\ :ref:`value` 将以指数方式而不是线性方式表示。 +如果为 ``true``\ ，并且 :ref:`min_value` 大于等于 ``0``\ ，则 :ref:`value` 将以指数方式而不是线性方式表示。 .. rst-class:: classref-item-separator @@ -260,7 +260,7 @@ Range 是代表特定范围内数字的控件的抽象基类，能够对步长 : - |void| **set_step**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_step**\ (\ ) -如果大于 0，\ :ref:`value` 将总是被四舍五入为这个属性的倍数。如果 :ref:`rounded` 也是 ``true``\ ，\ :ref:`value` 将首先被四舍五入为这个属性的倍数，然后舍入为最近的整数。 +If greater than 0, :ref:`value` will always be rounded to a multiple of this property's value above :ref:`min_value`. For example, if :ref:`min_value` is ``0.1`` and step is 0.2, then :ref:`value` is limited to ``0.1``, ``0.3``, ``0.5``, and so on. If :ref:`rounded` is also ``true``, :ref:`value` will first be rounded to a multiple of this property's value, then rounded to the nearest integer. .. rst-class:: classref-item-separator @@ -333,6 +333,7 @@ Range 的当前值。更改这个属性（即便是通过代码修改的）会 使该 **Range** 停止与任何其他 Range 共享其成员变量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_raycast2d.rst b/classes/zh_CN/class_raycast2d.rst index b16784c575..61ba3922e2 100644 --- a/classes/zh_CN/class_raycast2d.rst +++ b/classes/zh_CN/class_raycast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RayCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RayCast2D.xml. .. _class_RayCast2D: @@ -12,14 +12,14 @@ RayCast2D **继承：** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -2D 空间中的射线，用于查找第一个相交的 :ref:`CollisionObject2D`\ 。 +2D 空间中的射线，用于查找第一个相交的碰撞物体。 .. rst-class:: classref-introduction-group 描述 ---- -Raycast 代表的是从它的原点到 :ref:`target_position` 的射线，如果与碰撞对象相交，就能找到路径上距离最近的 :ref:`CollisionObject2D`\ 。 +Raycast 代表的是从它的原点到 :ref:`target_position` 的射线，如果与碰撞对象相交，就能找到路径上距离最近的对象。 要让 **RayCast2D** 忽略某些对象，可以通过将它们加入例外列表，也可以通过让检测汇报忽略 :ref:`Area2D`\ （\ :ref:`collide_with_areas`\ ）或 :ref:`PhysicsBody2D`\ （\ :ref:`collide_with_bodies`\ ），还可以通过配置物理层。 @@ -184,7 +184,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) - :ref:`bool` **get_exclude_parent_body**\ (\ ) -如果为 ``true``\ ，父节点将被排除在碰撞检测之外。 +如果为 ``true``\ ，则射线投射不会汇报与其父节点的碰撞。仅在父节点为 :ref:`CollisionObject2D` 时有效。另见 :ref:`Node.get_parent()`\ 、\ :ref:`add_exception()`\ 。 .. rst-class:: classref-item-separator @@ -218,7 +218,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) - :ref:`Vector2` **get_target_position**\ (\ ) -射线的目标点，相对于该 RayCast 的 ``position``\ 。 +射线的目的点，相对于射线投射的 :ref:`Node2D.position`\ 。 .. rst-class:: classref-section-separator @@ -235,7 +235,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) :ref:`🔗` -添加碰撞例外，这样射线就不会报告与指定 :ref:`CollisionObject2D` 节点的碰撞。 +添加碰撞例外，这样射线就不会报告与 ``node`` 节点的碰撞。 .. rst-class:: classref-item-separator @@ -285,7 +285,9 @@ Raycast 代表的是从它的原点到 :ref:`target_position` **get_collider**\ (\ ) |const| :ref:`🔗` -返回射线相交的第一个对象，如果没有对象与射线相交，则返回 ``null``\ （即 :ref:`is_colliding()` 返回 ``false``\ ）。 +返回射线相交的第一个物体，如果没有物体与射线相交则返回 ``null``\ （即 :ref:`is_colliding()` 返回 ``false``\ ）。 + +\ **注意：**\ 该物体不一定是 :ref:`CollisionObject2D`\ 。例如 :ref:`TileMapLayer` 相交时，方法返回的就是 :ref:`TileMapLayer` 实例。 .. rst-class:: classref-item-separator @@ -394,7 +396,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) :ref:`🔗` -移除碰撞例外，这样射线就会报告与指定的 :ref:`CollisionObject2D` 节点的碰撞。 +移除碰撞例外，这样射线就会报告与 ``node`` 节点的碰撞。 .. rst-class:: classref-item-separator @@ -421,6 +423,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position` 中指定的层，给定的 ``layer_number`` 应在 1 和 32 之间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_raycast3d.rst b/classes/zh_CN/class_raycast3d.rst index b3ab763d11..fad84149aa 100644 --- a/classes/zh_CN/class_raycast3d.rst +++ b/classes/zh_CN/class_raycast3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RayCast3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RayCast3D.xml. .. _class_RayCast3D: @@ -12,7 +12,7 @@ RayCast3D **继承：** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -3D 空间中的射线，用于查找第一个与其相交的物体。 +3D 空间中的射线，用于查找第一个与其相交的碰撞物体。 .. rst-class:: classref-introduction-group @@ -230,7 +230,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) - :ref:`bool` **get_exclude_parent_body**\ (\ ) -如果为 ``true``\ ，则该 RayCast3D 的直接父级的碰撞将被忽略。 +如果为 ``true``\ ，则射线投射不会汇报与其父节点的碰撞。仅在父节点为 :ref:`CollisionObject3D` 时有效。另见 :ref:`Node.get_parent()`\ 、\ :ref:`add_exception()`\ 。 .. rst-class:: classref-item-separator @@ -281,7 +281,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) - :ref:`Vector3` **get_target_position**\ (\ ) -射线的目标点，相对于该 RayCast 的 ``position``\ 。 +射线的目的点，相对于射线投射的 :ref:`Node3D.position`\ 。 .. rst-class:: classref-section-separator @@ -298,7 +298,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) :ref:`🔗` -添加碰撞例外，这样射线就不会报告与指定 :ref:`CollisionObject3D` 节点的碰撞。 +添加碰撞例外，这样射线就不会报告与 ``node`` 节点的碰撞。 .. rst-class:: classref-item-separator @@ -471,7 +471,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position`\ ) :ref:`🔗` -移除一个碰撞例外，以便射线确实报告与指定 :ref:`CollisionObject3D` 节点的碰撞。 +移除碰撞例外，这样射线就会报告与 ``node`` 节点的碰撞。 .. rst-class:: classref-item-separator @@ -498,6 +498,7 @@ Raycast 代表的是从它的原点到 :ref:`target_position` 中指定的层，给定的 ``layer_number`` 应在 1 和 32 之间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdattachmentformat.rst b/classes/zh_CN/class_rdattachmentformat.rst index 062aa2290d..1393d93632 100644 --- a/classes/zh_CN/class_rdattachmentformat.rst +++ b/classes/zh_CN/class_rdattachmentformat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDAttachmentFormat.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDAttachmentFormat.xml. .. _class_RDAttachmentFormat: @@ -94,6 +94,7 @@ RDAttachmentFormat 该附件的用途标志，用于确定能够进行的操作。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdframebufferpass.rst b/classes/zh_CN/class_rdframebufferpass.rst index 703bc7210b..8000664344 100644 --- a/classes/zh_CN/class_rdframebufferpass.rst +++ b/classes/zh_CN/class_rdframebufferpass.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDFramebufferPass.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDFramebufferPass.xml. .. _class_RDFramebufferPass: @@ -161,6 +161,7 @@ RDFramebufferPass **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinecolorblendstate.rst b/classes/zh_CN/class_rdpipelinecolorblendstate.rst index 9a4d238463..93ad17062b 100644 --- a/classes/zh_CN/class_rdpipelinecolorblendstate.rst +++ b/classes/zh_CN/class_rdpipelinecolorblendstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineColorBlendState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineColorBlendState.xml. .. _class_RDPipelineColorBlendState: @@ -113,6 +113,7 @@ RDPipelineColorBlendState 混合时执行的逻辑运算。仅在 :ref:`enable_logic_op` 为 ``true`` 时有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinecolorblendstateattachment.rst b/classes/zh_CN/class_rdpipelinecolorblendstateattachment.rst index 18d49b4b0d..ed5017ea33 100644 --- a/classes/zh_CN/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/zh_CN/class_rdpipelinecolorblendstateattachment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineColorBlendStateAttachment.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineColorBlendStateAttachment.xml. .. _class_RDPipelineColorBlendStateAttachment: @@ -342,6 +342,7 @@ Alpha 通道使用的混合模式。 使用普通（非预乘）Alpha 进行标准混合混合（mix blending）的简便方法。这个方法会将 :ref:`enable_blend` 设为 ``true``\ ，将 :ref:`src_color_blend_factor` 设为 :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA`\ ，将 :ref:`dst_color_blend_factor` 设为 :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`\ ，将 :ref:`src_alpha_blend_factor` 设为 :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA`\ ，将 :ref:`dst_alpha_blend_factor` 设为 :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinedepthstencilstate.rst b/classes/zh_CN/class_rdpipelinedepthstencilstate.rst index 540ca1f3f9..55761c0f5e 100644 --- a/classes/zh_CN/class_rdpipelinedepthstencilstate.rst +++ b/classes/zh_CN/class_rdpipelinedepthstencilstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineDepthStencilState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineDepthStencilState.xml. .. _class_RDPipelineDepthStencilState: @@ -436,6 +436,7 @@ RDPipelineDepthStencilState 选择正面模板值中的哪些位将被更改。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinemultisamplestate.rst b/classes/zh_CN/class_rdpipelinemultisamplestate.rst index 54845fee8b..7809a44326 100644 --- a/classes/zh_CN/class_rdpipelinemultisamplestate.rst +++ b/classes/zh_CN/class_rdpipelinemultisamplestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineMultisampleState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineMultisampleState.xml. .. _class_RDPipelineMultisampleState: @@ -151,6 +151,7 @@ RDPipelineMultisampleState 样本掩码。详见 `Vulkan 的样本掩码文档 `__\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinerasterizationstate.rst b/classes/zh_CN/class_rdpipelinerasterizationstate.rst index d3263cba56..a4f4fce61f 100644 --- a/classes/zh_CN/class_rdpipelinerasterizationstate.rst +++ b/classes/zh_CN/class_rdpipelinerasterizationstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineRasterizationState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineRasterizationState.xml. .. _class_RDPipelineRasterizationState: @@ -246,6 +246,7 @@ RDPipelineRasterizationState 如果为 ``true``\ ，则会为三角形进行线框渲染，不进行平面或纹理渲染。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdpipelinespecializationconstant.rst b/classes/zh_CN/class_rdpipelinespecializationconstant.rst index 284f1b2858..c765e125d3 100644 --- a/classes/zh_CN/class_rdpipelinespecializationconstant.rst +++ b/classes/zh_CN/class_rdpipelinespecializationconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDPipelineSpecializationConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineSpecializationConstant.xml. .. _class_RDPipelineSpecializationConstant: @@ -77,6 +77,7 @@ RDPipelineSpecializationConstant 特化常量的值。只有 :ref:`bool`\ 、\ :ref:`int`\ 、\ :ref:`float` 类型是有效的特化常量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdsamplerstate.rst b/classes/zh_CN/class_rdsamplerstate.rst index bd72e24bc8..8cd737cc9e 100644 --- a/classes/zh_CN/class_rdsamplerstate.rst +++ b/classes/zh_CN/class_rdsamplerstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDSamplerState.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDSamplerState.xml. .. _class_RDSamplerState: @@ -324,6 +324,7 @@ Mipmap 使用的过滤方法。 如果为 ``true``\ ，则执行各向异性采样。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdshaderfile.rst b/classes/zh_CN/class_rdshaderfile.rst index e67525b202..2440cf3843 100644 --- a/classes/zh_CN/class_rdshaderfile.rst +++ b/classes/zh_CN/class_rdshaderfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDShaderFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderFile.xml. .. _class_RDShaderFile: @@ -115,6 +115,7 @@ RDShaderFile 设置指定着色器版本 ``version`` 要编译的 SPIR-V 字节码 ``bytecode``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdshadersource.rst b/classes/zh_CN/class_rdshadersource.rst index 0942f59ba6..64033a719f 100644 --- a/classes/zh_CN/class_rdshadersource.rst +++ b/classes/zh_CN/class_rdshadersource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDShaderSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderSource.xml. .. _class_RDShaderSource: @@ -198,6 +198,7 @@ RDShaderSource \ **注意：**\ 如果直接使用该方法设置计算着色器的源代码，请记得移除 Godot 专有的 ``#[compute]`` 提示。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdshaderspirv.rst b/classes/zh_CN/class_rdshaderspirv.rst index 499ef11f3a..28c6b6366b 100644 --- a/classes/zh_CN/class_rdshaderspirv.rst +++ b/classes/zh_CN/class_rdshaderspirv.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDShaderSPIRV.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderSPIRV.xml. .. _class_RDShaderSPIRV: @@ -310,6 +310,7 @@ SPIR-V 中间表示，是 :ref:`RDShaderFile` 的一部分 设置给定着色器阶段 ``stage`` 的编译错误消息。等价于设置 :ref:`compile_error_compute`\ 、\ :ref:`compile_error_fragment`\ 、\ :ref:`compile_error_tesselation_control`\ 、\ :ref:`compile_error_tesselation_evaluation`\ 、\ :ref:`compile_error_vertex` 的其中之一。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdtextureformat.rst b/classes/zh_CN/class_rdtextureformat.rst index c1db81626d..40e2f302ed 100644 --- a/classes/zh_CN/class_rdtextureformat.rst +++ b/classes/zh_CN/class_rdtextureformat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDTextureFormat.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDTextureFormat.xml. .. _class_RDTextureFormat: @@ -291,6 +291,7 @@ RDTextureFormat 从相应 :ref:`RDTextureView` 的 :ref:`RDTextureView.format_override` 属性可以设置的有效格式列表中移除 ``format``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdtextureview.rst b/classes/zh_CN/class_rdtextureview.rst index 90250e33d1..fcadac1044 100644 --- a/classes/zh_CN/class_rdtextureview.rst +++ b/classes/zh_CN/class_rdtextureview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDTextureView.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDTextureView.xml. .. _class_RDTextureView: @@ -132,6 +132,7 @@ RDTextureView 对红色通道进行采样时采样的通道。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rduniform.rst b/classes/zh_CN/class_rduniform.rst index b7d7eb3a0e..c691f8a629 100644 --- a/classes/zh_CN/class_rduniform.rst +++ b/classes/zh_CN/class_rduniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDUniform.xml. .. _class_RDUniform: @@ -132,6 +132,7 @@ Uniform 的数据类型。 返回当前绑定到该 uniform 的所有 id 的数组。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rdvertexattribute.rst b/classes/zh_CN/class_rdvertexattribute.rst index 8c22e386f2..2701d5484c 100644 --- a/classes/zh_CN/class_rdvertexattribute.rst +++ b/classes/zh_CN/class_rdvertexattribute.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RDVertexAttribute.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDVertexAttribute.xml. .. _class_RDVertexAttribute: @@ -132,6 +132,7 @@ RDVertexAttribute 该属性相邻两个实例之间的字节数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rect2.rst b/classes/zh_CN/class_rect2.rst index 65c4757fc1..0f84e3697b 100644 --- a/classes/zh_CN/class_rect2.rst +++ b/classes/zh_CN/class_rect2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Rect2.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Rect2.xml. .. _class_Rect2: @@ -298,14 +298,14 @@ Rect2 .. code-tab:: gdscript var rect = Rect2(0, 0, 5, 2) - + rect = rect.expand(Vector2(10, 0)) # rect 为 Rect2(0, 0, 10, 2) rect = rect.expand(Vector2(-5, 5)) # rect 为 Rect2(-5, 0, 15, 5) .. code-tab:: csharp var rect = new Rect2(0, 0, 5, 2); - + rect = rect.Expand(new Vector2(10, 0)); // rect 为 Rect2(0, 0, 10, 2) rect = rect.Expand(new Vector2(-5, 5)); // rect 为 Rect2(-5, 0, 15, 5) @@ -443,14 +443,14 @@ Rect2 var rect1 = Rect2(0, 0, 5, 10) var rect2 = Rect2(2, 0, 8, 4) - + var a = rect1.intersection(rect2) # a 为 Rect2(2, 0, 3, 4) .. code-tab:: csharp var rect1 = new Rect2(0, 0, 5, 10); var rect2 = new Rect2(2, 0, 8, 4); - + var a = rect1.Intersection(rect2); // a 为 Rect2(2, 0, 3, 4) @@ -555,6 +555,7 @@ Rect2 \ **注意：**\ 由于浮点数精度误差，请考虑改用 :ref:`is_equal_approx()`\ ，会更可靠。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rect2i.rst b/classes/zh_CN/class_rect2i.rst index 986b3d520a..2fadcf00e3 100644 --- a/classes/zh_CN/class_rect2i.rst +++ b/classes/zh_CN/class_rect2i.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Rect2i.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Rect2i.xml. .. _class_Rect2i: @@ -288,14 +288,14 @@ Rect2i .. code-tab:: gdscript var rect = Rect2i(0, 0, 5, 2) - + rect = rect.expand(Vector2i(10, 0)) # rect 为 Rect2i(0, 0, 10, 2) rect = rect.expand(Vector2i(-5, 5)) # rect 为 Rect2i(-5, 0, 15, 5) .. code-tab:: csharp var rect = new Rect2I(0, 0, 5, 2); - + rect = rect.Expand(new Vector2I(10, 0)); // rect 为 Rect2I(0, 0, 10, 2) rect = rect.Expand(new Vector2I(-5, 5)); // rect 为 Rect2I(-5, 0, 15, 5) @@ -423,14 +423,14 @@ Rect2i var a = Rect2i(0, 0, 5, 10) var b = Rect2i(2, 0, 8, 4) - + var c = a.intersection(b) # c 为 Rect2i(2, 0, 3, 4) .. code-tab:: csharp var a = new Rect2I(0, 0, 5, 10); var b = new Rect2I(2, 0, 8, 4); - + var c = rect1.Intersection(rect2); // c 为 Rect2I(2, 0, 3, 4) @@ -491,6 +491,7 @@ Rect2i 如果该矩形的 :ref:`position` 和 :ref:`size` 分别相等，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rectangleshape2d.rst b/classes/zh_CN/class_rectangleshape2d.rst index a0aea7ca89..26c1898e26 100644 --- a/classes/zh_CN/class_rectangleshape2d.rst +++ b/classes/zh_CN/class_rectangleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RectangleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RectangleShape2D.xml. .. _class_RectangleShape2D: @@ -67,6 +67,7 @@ RectangleShape2D 该矩形的宽度和高度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_refcounted.rst b/classes/zh_CN/class_refcounted.rst index 53b8b54490..5bb612b77d 100644 --- a/classes/zh_CN/class_refcounted.rst +++ b/classes/zh_CN/class_refcounted.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RefCounted.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RefCounted.xml. .. _class_RefCounted: @@ -12,7 +12,7 @@ RefCounted **继承：** :ref:`Object` -**派生：** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**派生：** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` 引用计数对象的基类。 @@ -116,6 +116,7 @@ RefCounted 如果减少成功则返回 ``true``\ ，否则返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_referencerect.rst b/classes/zh_CN/class_referencerect.rst index c9f46f32d0..43cedc334c 100644 --- a/classes/zh_CN/class_referencerect.rst +++ b/classes/zh_CN/class_referencerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ReferenceRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ReferenceRect.xml. .. _class_ReferenceRect: @@ -12,14 +12,14 @@ ReferenceRect **继承：** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -设计 UI 使用的矩形提示。 +用于设计 UI 的矩形框。 .. rst-class:: classref-introduction-group 描述 ---- -仅在对应矩形周围上显示彩色边框的矩形框。用于将 :ref:`Control` 的范围可视化。 +仅在对应矩形周围上显示彩色边框的矩形框（见 :ref:`Control.get_rect()`\ ）。可以用来在测试时显示 :ref:`Control` 的范围。 .. rst-class:: classref-reftable-group @@ -94,6 +94,7 @@ ReferenceRect 如果为 ``true``\ ，则 **ReferenceRect** 仅在编辑器中可见。否则，\ **ReferenceRect** 将在正在运行的项目中可见。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_reflectionprobe.rst b/classes/zh_CN/class_reflectionprobe.rst index c72b3d4ff9..ffa4232eb4 100644 --- a/classes/zh_CN/class_reflectionprobe.rst +++ b/classes/zh_CN/class_reflectionprobe.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ReflectionProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ReflectionProbe.xml. .. _class_ReflectionProbe: @@ -28,9 +28,9 @@ ReflectionProbe \ **注意：**\ 与 :ref:`VoxelGI` 和 SDFGI 不同，\ **ReflectionProbe** 仅从一个 :ref:`WorldEnvironment` 节点获取环境。如果你在一个 :ref:`Camera3D` 节点中指定了一个 :ref:`Environment` 资源，它将被该 **ReflectionProbe** 忽略。这可能会导致 **ReflectionProbe** 内的照明不正确。 -\ **注意：**\ 反射探针仅支持 Forward+ 和 Mobile 渲染方法，不支持 Compatibility。使用移动渲染方法时，每个网格资源上最多只能显示 8 个反射探针。尝试在单个网格资源上显示 8 个以上的反射探针，将导致反射探针随着相机移动而闪烁。 +\ **注意：**\ 使用移动渲染方法时，每个网格资源上最多只能显示 ``8`` 个反射探针，使用兼容渲染方法时每个网格仅支持 ``2`` 个反射探针。尝试在单个网格资源上显示 ``8`` 个以上的反射探针，在使用移动渲染方法时会导致反射探针随着相机移动而闪烁。使用兼容渲染方法时，如果使用超过 ``2`` 个反射探针就会忽略多余的探针不渲染。 -\ **注意：**\ 当使用移动渲染方法时，反射探针只会正确地影响可见 AABB 与反射探针的 AABB 相交的网格。如果使用着色器以使网格超出其 AABB 的方式变形该网格，则必须在网格上增加 :ref:`GeometryInstance3D.extra_cull_margin`\ 。否则，反射探针可能在网格上不可见。 +\ **注意：**\ 使用移动渲染方法时，反射探针只会正确地影响可见 AABB 与反射探针的 AABB 相交的网格。如果使用着色器以使网格超出其 AABB 的方式变形该网格，则必须在网格上增加 :ref:`GeometryInstance3D.extra_cull_margin`\ 。否则，反射探针可能在网格上不可见。 .. rst-class:: classref-introduction-group @@ -415,6 +415,7 @@ enum **AmbientMode**: :ref:`🔗` 设置该 **ReflectionProbe** 的更新频率。可以是 :ref:`UPDATE_ONCE` 或 :ref:`UPDATE_ALWAYS`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_regex.rst b/classes/zh_CN/class_regex.rst index 0262bd60b4..2089ffe0d7 100644 --- a/classes/zh_CN/class_regex.rst +++ b/classes/zh_CN/class_regex.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/regex/doc_classes/RegEx.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/regex/doc_classes/RegEx.xml. .. _class_RegEx: @@ -38,7 +38,7 @@ RegEx regex.compile("\\w-(\\d+)") var result = regex.search("abc n-0123") if result: - print(result.get_string()) # 会输出 n-0123 + print(result.get_string()) # 输出“n-0123” 捕获组的结果 ``()`` 可以通过向 :ref:`RegExMatch` 中的各种方法传递组号来检索。默认是组 0，并且将总是指整个模式。在上面的例子中，调用 ``result.get_string(1)`` 会得到 ``0123``\ 。 @@ -50,7 +50,7 @@ RegEx regex.compile("d(?[0-9]+)|x(?[0-9a-f]+)") var result = regex.search("数字是 x2f") if result: - print(result.get_string("digit")) # 会输出 2f + print(result.get_string("digit")) # 输出“2f” 如果你需要处理多个结果，\ :ref:`search_all()` 会生成一个所有不重叠的结果列表。为了方便起见，这可以和一个 ``for`` 循环结合起来。 @@ -69,7 +69,7 @@ RegEx var results = [] for result in regex.search_all("One Two \n\tThree"): results.push_back(result.get_string()) - # `results` 数组包含“One”“Two”“Three”。 + print(results) # 输出 ["One", "Two", "Three"] \ **注意：**\ Godot 的 regex 实现基于的是 `PCRE2 `__\ 。你可以查看完整的模式参考\ `这里 `__\ 。 @@ -237,6 +237,7 @@ RegEx 可以使用 ``offset`` 和 ``end`` 指定要搜索的区域。这对在上一次成功后再次调用该方法，以相同的 ``subject`` 搜索另一个匹配项时很有用。请注意，设置这些参数不同于传递缩短后的字符串。例如，起始锚点 ``^`` 不受 ``offset`` 的影响，会为单词边界 ``\b`` 检查 ``offset`` 之前的字符。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_regexmatch.rst b/classes/zh_CN/class_regexmatch.rst index 3029d84754..28d3030388 100644 --- a/classes/zh_CN/class_regexmatch.rst +++ b/classes/zh_CN/class_regexmatch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/regex/doc_classes/RegExMatch.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/regex/doc_classes/RegExMatch.xml. .. _class_RegExMatch: @@ -170,6 +170,7 @@ RegExMatch 如果组没有匹配或不存在，则返回一个空字符串。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_remotetransform2d.rst b/classes/zh_CN/class_remotetransform2d.rst index ee27096ff7..ba52f24e49 100644 --- a/classes/zh_CN/class_remotetransform2d.rst +++ b/classes/zh_CN/class_remotetransform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RemoteTransform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RemoteTransform2D.xml. .. _class_RemoteTransform2D: @@ -163,6 +163,7 @@ RemoteTransform2D 会将自己的 :ref:`Transform2D` 推送 **RemoteTransform2D** 缓存了远程节点。如果远程节点消失了，它可能不会通知；\ :ref:`force_update_cache()` 强制它再次更新缓存。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_remotetransform3d.rst b/classes/zh_CN/class_remotetransform3d.rst index c22a4d7ac4..d2de04ef08 100644 --- a/classes/zh_CN/class_remotetransform3d.rst +++ b/classes/zh_CN/class_remotetransform3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RemoteTransform3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RemoteTransform3D.xml. .. _class_RemoteTransform3D: @@ -163,6 +163,7 @@ RemoteTransform3D 会将自己的 :ref:`Transform3D` 推送 **RemoteTransform3D** 缓存了远程节点。如果远程节点消失了，它可能不会通知；\ :ref:`force_update_cache()` 强制它再次更新缓存。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderdata.rst b/classes/zh_CN/class_renderdata.rst index 000fdb2d07..ca32070d9a 100644 --- a/classes/zh_CN/class_renderdata.rst +++ b/classes/zh_CN/class_renderdata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderData.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderData.xml. .. _class_RenderData: @@ -97,6 +97,7 @@ RenderData 返回管理这个帧场景数据的 :ref:`RenderSceneData` 对象。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderdataextension.rst b/classes/zh_CN/class_renderdataextension.rst index af15a84509..cf55cd85ea 100644 --- a/classes/zh_CN/class_renderdataextension.rst +++ b/classes/zh_CN/class_renderdataextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderDataExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderDataExtension.xml. .. _class_RenderDataExtension: @@ -93,6 +93,7 @@ RenderDataExtension 在 GDExtension 中实现它以返回实现的 :ref:`RenderSceneDataExtension` 对象。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderdatard.rst b/classes/zh_CN/class_renderdatard.rst index a9c5c1cd96..58230b871c 100644 --- a/classes/zh_CN/class_renderdatard.rst +++ b/classes/zh_CN/class_renderdatard.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderDataRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderDataRD.xml. .. _class_RenderDataRD: @@ -26,6 +26,7 @@ RenderDataRD \ **注意：**\ 这是一个仅为 GDExtension 插件公开的内部渲染服务器对象。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderingdevice.rst b/classes/zh_CN/class_renderingdevice.rst index 0d36c9023b..a5f79fc48f 100644 --- a/classes/zh_CN/class_renderingdevice.rst +++ b/classes/zh_CN/class_renderingdevice.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderingDevice.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingDevice.xml. .. _class_RenderingDevice: @@ -239,7 +239,7 @@ RenderingDevice +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create`\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create_from_extension`\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) | + | :ref:`RID` | :ref:`texture_create_from_extension`\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int` = 1\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared`\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -359,9 +359,13 @@ enum **DriverResource**: :ref:`🔗` :ref:`DriverResource` **DRIVER_RESOURCE_LOGICAL_DEVICE** = ``0`` -基于物理设备的特定设备对象。 +基于物理设备的特定设备对象（忽略 ``rid`` 参数）。 -- Vulkan：Vulkan 设备驱动资源（\ ``VkDevice``\ ）。（\ ``rid`` 参数不适用。） +- Vulkan：Vulkan 设备驱动资源（\ ``VkDevice``\ ）。 + +- D3D12：D3D12 设备驱动资源（\ ``ID3D12Device``\ ）。 + +- Metal：Metal 设备驱动资源（\ ``MTLDevice``\ ）。 .. _class_RenderingDevice_constant_DRIVER_RESOURCE_PHYSICAL_DEVICE: @@ -369,9 +373,11 @@ enum **DriverResource**: :ref:`🔗` :ref:`DriverResource` **DRIVER_RESOURCE_PHYSICAL_DEVICE** = ``1`` -特定逻辑设备基于的物理设备。 +指定的逻辑设备基于的物理设备（忽略 ``rid`` 参数）。 -- Vulkan：\ ``VkDevice``\ 。（\ ``rid`` 参数不适用。） +- Vulkan：\ ``VkPhysicalDevice``\ 。 + +- D3D12：\ ``IDXGIAdapter``\ 。 .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TOPMOST_OBJECT: @@ -379,9 +385,9 @@ enum **DriverResource**: :ref:`🔗` :ref:`DriverResource` **DRIVER_RESOURCE_TOPMOST_OBJECT** = ``2`` -顶层图形 API 入口对象。 +顶层图形 API 入口对象（忽略 ``rid`` 参数）。 -- Vulkan：\ ``VkInstance``\ 。（\ ``rid`` 参数不适用。） +- Vulkan：\ ``VkInstance``\ 。 .. _class_RenderingDevice_constant_DRIVER_RESOURCE_COMMAND_QUEUE: @@ -389,9 +395,11 @@ enum **DriverResource**: :ref:`🔗` :ref:`DriverResource` **DRIVER_RESOURCE_COMMAND_QUEUE** = ``3`` -主要图形计算命令队列。 +主要图形计算命令队列（忽略 ``rid`` 参数）。 -- Vulkan：\ ``VkQueue``\ 。（\ ``rid`` 参数不适用。） +- Vulkan：\ ``VkQueue``\ 。 + +- Metal：\ ``MTLCommandQueue``\ 。 .. _class_RenderingDevice_constant_DRIVER_RESOURCE_QUEUE_FAMILY: @@ -399,9 +407,9 @@ enum **DriverResource**: :ref:`🔗` :ref:`DriverResource` **DRIVER_RESOURCE_QUEUE_FAMILY** = ``4`` -主要队列属于的家族。 +主要队列所属的家族（忽略 ``rid`` 参数）。 -- Vulkan：队列家族索引，是一个 ``uint32_t``\ 。（\ ``rid`` 参数不适用。） +- Vulkan：队列家族索引，是一个 ``uint32_t``\ 。 .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE: @@ -421,6 +429,8 @@ enum **DriverResource**: :ref:`🔗` - Vulkan：\ ``VkImageView``\ 。 +- D3D12：\ ``ID3D12Resource``\ 。 + .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE_DATA_FORMAT: .. rst-class:: classref-enumeration-constant @@ -431,6 +441,8 @@ enum **DriverResource**: :ref:`🔗` - Vulkan：\ ``VkFormat``\ 。 +- D3D12：\ ``DXGI_FORMAT``\ 。 + .. _class_RenderingDevice_constant_DRIVER_RESOURCE_SAMPLER: .. rst-class:: classref-enumeration-constant @@ -457,6 +469,8 @@ enum **DriverResource**: :ref:`🔗` - Vulkan：\ ``VkBuffer``\ 。 +- D3D12：\ ``ID3D12Resource``\ 。 + .. _class_RenderingDevice_constant_DRIVER_RESOURCE_COMPUTE_PIPELINE: .. rst-class:: classref-enumeration-constant @@ -465,6 +479,8 @@ enum **DriverResource**: :ref:`🔗` - Vulkan：\ ``VkPipeline``\ 。 +- Metal：\ ``MTLComputePipelineState``\ 。 + .. _class_RenderingDevice_constant_DRIVER_RESOURCE_RENDER_PIPELINE: .. rst-class:: classref-enumeration-constant @@ -473,6 +489,8 @@ enum **DriverResource**: :ref:`🔗` - Vulkan：\ ``VkPipeline``\ 。 +- Metal：\ ``MTLRenderPipelineState``\ 。 + .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE: .. rst-class:: classref-enumeration-constant @@ -3195,10 +3213,10 @@ flags **BufferCreationBits**: :ref:`🔗` +.. _class_RenderingDevice_constant_SUPPORTS_METALFX_SPATIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Features` **SUPPORTS_METALFX_SPATIAL** = ``3`` + +支持 MetaFX 空间超分辨率。 + +.. _class_RenderingDevice_constant_SUPPORTS_METALFX_TEMPORAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Features` **SUPPORTS_METALFX_TEMPORAL** = ``4`` + +支持 MetaFX 时间超分辨率。 + .. _class_RenderingDevice_constant_SUPPORTS_BUFFER_DEVICE_ADDRESS: .. rst-class:: classref-enumeration-constant @@ -4444,6 +4478,14 @@ enum **Features**: :ref:`🔗` 支持缓冲区设备地址扩展的功能。 +.. _class_RenderingDevice_constant_SUPPORTS_IMAGE_ATOMIC_32_BIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Features` **SUPPORTS_IMAGE_ATOMIC_32_BIT** = ``7`` + +支持 32 位图像原子操作。 + .. rst-class:: classref-item-separator ---- @@ -4820,11 +4862,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **NONE** = ``0`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +不添加面包屑标记。 .. _class_RenderingDevice_constant_REFLECTION_PROBES: @@ -4832,11 +4870,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **REFLECTION_PROBES** = ``65536`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"REFLECTION_PROBES"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_SKY_PASS: @@ -4844,11 +4878,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **SKY_PASS** = ``131072`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"SKY_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_LIGHTMAPPER_PASS: @@ -4856,11 +4886,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **LIGHTMAPPER_PASS** = ``196608`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"LIGHTMAPPER_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_SHADOW_PASS_DIRECTIONAL: @@ -4868,11 +4894,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **SHADOW_PASS_DIRECTIONAL** = ``262144`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"SHADOW_PASS_DIRECTIONAL"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_SHADOW_PASS_CUBE: @@ -4880,11 +4902,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **SHADOW_PASS_CUBE** = ``327680`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"SHADOW_PASS_CUBE"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_OPAQUE_PASS: @@ -4892,11 +4910,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **OPAQUE_PASS** = ``393216`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"OPAQUE_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_ALPHA_PASS: @@ -4904,11 +4918,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **ALPHA_PASS** = ``458752`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"ALPHA_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_TRANSPARENT_PASS: @@ -4916,11 +4926,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **TRANSPARENT_PASS** = ``524288`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"TRANSPARENT_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_POST_PROCESSING_PASS: @@ -4928,11 +4934,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **POST_PROCESSING_PASS** = ``589824`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"POST_PROCESSING_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_BLIT_PASS: @@ -4940,11 +4942,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **BLIT_PASS** = ``655360`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"BLIT_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_UI_PASS: @@ -4952,11 +4950,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **UI_PASS** = ``720896`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"UI_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. _class_RenderingDevice_constant_DEBUG_PASS: @@ -4964,11 +4958,7 @@ enum **BreadcrumbMarker**: :ref:`🔗` :ref:`BreadcrumbMarker` **DEBUG_PASS** = ``786432`` -.. container:: contribute - - 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ - - +开发模式或调试模式下 GPU 崩溃时，Godot 的报错消息中会包含 ``"DEBUG_PASS"``\ ，提供崩溃发生时的额外上下文信息。 .. rst-class:: classref-item-separator @@ -5316,9 +5306,9 @@ flags **DrawFlags**: :ref:`🔗` func _buffer_get_data_callback(array): value = array.decode_u32(0) - + ... - + rd.buffer_get_data_async(buffer, _buffer_get_data_callback) .. rst-class:: classref-item-separator @@ -5399,16 +5389,16 @@ flags **DrawFlags**: :ref:`🔗` var rd = RenderingDevice.new() var compute_list = rd.compute_list_begin() - + rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline) rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0) rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1) - + for i in atlas_slices: rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size()) rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z) # 没有屏障，一起执行。 - + rd.compute_list_end() .. rst-class:: classref-item-separator @@ -5582,7 +5572,7 @@ Vulkan 扩展 ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` 必须可用并启用，这 var rd = RenderingDevice.new() var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)]) var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS) - + # 实心绘图。 rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline) rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0) @@ -5593,7 +5583,7 @@ Vulkan 扩展 ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` 必须可用并启用，这 rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0) rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size()) rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3) - + rd.draw_list_end() \ ``draw_flags`` 表示应将帧缓冲的纹理附件清空还是忽略。每个独立的附件都只能在这两个标志中二选一。忽略附件就是完全丢弃绘图列表之前已存在的内容，能够降低渲染阶段所使用的内存带宽，但如果没有对像素进行替换就会出现垃圾结果。默认行为能够让引擎判断纹理可丢弃时的正确操作，可以提升性能。见 :ref:`RDTextureFormat` 或 :ref:`texture_set_discardable()`\ 。 @@ -6182,7 +6172,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **get_driver_resource**\ (\ resource\: :ref:`DriverResource`, rid\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` -返回指定 ``rid`` 的驱动资源 ``resource`` 的唯一标识符。部分驱动资源类型会忽略指定的 ``rid``\ （说明见 :ref:`DriverResource`\ ）。\ ``index`` 始终会被忽略，但仍然必须指定。 +返回指定 ``rid`` 的驱动资源 ``resource`` 的唯一标识符。部分驱动资源类型会忽略指定的 ``rid``\ 。\ ``index`` 始终会被忽略，但仍然必须指定。 .. rst-class:: classref-item-separator @@ -6626,6 +6616,8 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 +\ **注意：**\ ``data`` 接受的是 :ref:`PackedByteArray` 的 :ref:`Array`\ 。如果纹理是 :ref:`TEXTURE_TYPE_1D`\ 、\ :ref:`TEXTURE_TYPE_2D`\ 、\ :ref:`TEXTURE_TYPE_3D` 类型，则数组中应该只有一个元素，是包含纹理数据的 :ref:`PackedByteArray`\ 。如果是 ``_ARRAY``\ 、\ ``_CUBE`` 类型，则长度应该与 ``format`` 的 :ref:`RDTextureFormat.array_layers` 数量一致。 + \ **注意：**\ 请勿与 :ref:`RenderingServer.texture_2d_create()` 混淆，后者创建的是 Godot 专属的 :ref:`Texture2D` 资源，不是图形 API 自己的纹理类型。 .. rst-class:: classref-item-separator @@ -6636,9 +6628,9 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) :ref:`🔗` +:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int` = 1\ ) :ref:`🔗` -使用给定的 ``type``\ 、\ ``format``\ 、\ ``samples``\ 、\ ``usage_flags``\ 、\ ``width``\ 、\ ``height``\ 、\ ``depth`` 和 ``layers`` 返回已有 ``image``\ （\ ``VkImage``\ ）的 RID。这可被用于允许 Godot 渲染到外部图像上。 +使用给定的 ``type``\ 、\ ``format``\ 、\ ``samples``\ 、\ ``usage_flags``\ 、\ ``width``\ 、\ ``height``\ 、\ ``depth``\ 、\ ``layers``\ 、\ ``mipmaps`` 返回已有 ``image``\ （\ ``VkImage``\ ）的 RID。可用于允许 Godot 渲染到外部图像上。 .. rst-class:: classref-item-separator @@ -6706,9 +6698,9 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), creation_bits\: |bitfield|\[:ref:`BufferCreationBits`\] = 0\ ) :ref:`🔗` -以通过返回的 RID 进行访问。 +新建顶点缓冲。可以通过返回的 RID 进行访问。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 @@ -6926,6 +6918,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_fog_depth`\ (\ env\: :ref:`RID`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_glow`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) | @@ -493,8 +495,6 @@ RenderingServer +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_visibility_range`\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`instance_reset_physics_interpolation`\ (\ instance\: :ref:`RID`\ ) | - +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_base`\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_blend_shape_weight`\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) | @@ -505,8 +505,6 @@ RenderingServer +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_ignore_culling`\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`instance_set_interpolated`\ (\ instance\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | - +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_layer_mask`\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_pivot_data`\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) | @@ -521,6 +519,8 @@ RenderingServer +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_visible`\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_teleport`\ (\ instance\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_aabb`\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_convex`\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| | @@ -631,6 +631,8 @@ RenderingServer +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_index_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_normal_tangent_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_offset`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| | @@ -647,6 +649,8 @@ RenderingServer +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_attribute_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_surface_update_index_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_skin_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_vertex_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | @@ -1720,7 +1724,7 @@ flags **ArrayFormat**: :ref:`🔗` :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` -网格数据将在 GLES 上使用 ``GL_DYNAMIC_DRAW`` 的标记索引。在 Vulkan 上未被使用。 +用于标记网格数据将在 GLES 上使用 ``GL_DYNAMIC_DRAW`` 的标志。在 Vulkan 上不使用。 .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: @@ -2158,7 +2162,7 @@ enum **LightParam**: :ref:`🔗` :ref:`LightParam` **LIGHT_PARAM_SHADOW_BIAS** = ``15`` -对阴影查找进行偏置，以修复自我阴影的假象。 +对阴影查找进行偏置，从而修复自我阴影的问题。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE: @@ -3384,11 +3388,19 @@ enum **ViewportScreenSpaceAA**: :ref:`🔗` **VIEWPORT_SCREEN_SPACE_AA_SMAA** = ``2`` + +使用次像素形态抗锯齿。SMAA 得到的结果可能比 FXAA 更清晰，但是性能开销会稍微高一些。 + .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX: .. rst-class:: classref-enumeration-constant -:ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2`` +:ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``3`` 代表 :ref:`ViewportScreenSpaceAA` 枚举的大小。 @@ -3542,7 +3554,9 @@ enum **ViewportDebugDraw**: :ref:`🔗` :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2`` -仅使用光照信息显示对象。 +对象只使用光照信息显示。 + +\ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: @@ -3552,7 +3566,7 @@ enum **ViewportDebugDraw**: :ref:`🔗` 对象通过加法混合显示为半透明，因此可以看到它们在彼此之上绘制的位置。更高的过度绘制（由更亮的颜色表示）意味着在绘制隐藏在其他像素后面的像素时浪费了性能。 -\ **注意：**\ 使用该调试绘制模式时，自定义着色器将被忽略。这意味着顶点置换不再可见。 +\ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: @@ -3578,7 +3592,9 @@ enum **ViewportDebugDraw**: :ref:`🔗` :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6`` -仅使用来自 :ref:`VoxelGI` 的反照率值显示对象。 +对象只使用 :ref:`VoxelGI` 中的反照率值显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 + +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING: @@ -3586,7 +3602,9 @@ enum **ViewportDebugDraw**: :ref:`🔗` :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7`` -仅使用来自 :ref:`VoxelGI` 的照明值显示对象。 +对象只使用 :ref:`VoxelGI` 中的光照值显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 + +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION: @@ -3594,7 +3612,9 @@ enum **ViewportDebugDraw**: :ref:`🔗` :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8`` -仅使用来自 :ref:`VoxelGI` 的自发光颜色显示对象。 +对象只使用 :ref:`VoxelGI` 中的发光颜色显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 + +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS: @@ -3624,6 +3644,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制估计的场景亮度。这是一个 1×1 的纹理，启用自动曝光时生成，用于控制场景的曝光。 +\ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO: .. rst-class:: classref-enumeration-constant @@ -3632,6 +3654,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制屏幕空间环境光遮蔽纹理而不是场景，以便可以清楚地看到它是如何影响对象的。为了使这种显示模式起作用，必须在 :ref:`WorldEnvironment` 中设置 :ref:`Environment.ssao_enabled`\ 。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL: .. rst-class:: classref-enumeration-constant @@ -3640,13 +3664,19 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制屏幕空间间接照明纹理而不是场景，以便可以清楚地看到它是如何影响对象的。为了使这种显示模式起作用，必须在 :ref:`WorldEnvironment` 中设置 :ref:`Environment.ssil_enabled`\ 。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14`` -为场景中的 :ref:`DirectionalLight3D` 的每个 PSSM 分割着色不同的颜色，以便可以看到分割的位置。它们将按顺序被着色为红色、绿色、蓝色、黄色。 +将场景中 :ref:`DirectionalLight3D` 的各个 PSSM 拆分用不同的颜色着色，便于查看拆分的位置。着色（按照距离相机由近到远）的顺序为红、绿、蓝、黄。 + +\ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 + +\ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS: @@ -3656,6 +3686,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制贴花图集，图集中保存的是各个 :ref:`Decal` 中的贴花纹理。 +\ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI: .. rst-class:: classref-enumeration-constant @@ -3664,6 +3696,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 SDFGI 级联数据。这是用于反弹灯光、创建反射的数据结构。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES: .. rst-class:: classref-enumeration-constant @@ -3672,13 +3706,17 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 SDFGI 探针数据。这是用于为场景中移动的动态对象提供间接光照的数据结构。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18`` -绘制全局光照缓冲（\ :ref:`VoxelGI` 或 SDFGI）。 +绘制 :ref:`VoxelGI` 或 SDFGI 的全局光照缓冲。需要启用 :ref:`VoxelGI`\ （至少存在一个可见且已烘焙的 VoxelGI 节点）或 SDFGI（\ :ref:`Environment.sdfgi_enabled`\ ）才能有可见的效果。 + +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD: @@ -3696,6 +3734,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 :ref:`OmniLight3D` 集群。集群决定屏幕空间中灯光的放置位置，能够让引擎在进行光照时仅对屏幕的部分区域进行处理。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS: .. rst-class:: classref-enumeration-constant @@ -3704,6 +3744,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 :ref:`SpotLight3D` 集群。集群决定屏幕空间中灯光的放置位置，能够让引擎在进行光照时仅对屏幕的部分区域进行处理。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS: .. rst-class:: classref-enumeration-constant @@ -3712,6 +3754,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 :ref:`Decal` 集群。集群决定屏幕空间中贴花的放置位置，能够让引擎在进行贴花时仅对屏幕的部分区域进行处理。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES: .. rst-class:: classref-enumeration-constant @@ -3720,6 +3764,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制 :ref:`ReflectionProbe` 集群。集群决定屏幕空间中反射探针的放置位置，能够让引擎在处理反射探针时仅对屏幕的部分区域进行处理。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS: .. rst-class:: classref-enumeration-constant @@ -3728,6 +3774,8 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制遮挡剔除缓冲。这个低分辨率遮挡剔除缓冲在 CPU 栅格化，可用于检查实例是否被其他对象遮挡。 +\ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant @@ -3736,13 +3784,17 @@ enum **ViewportDebugDraw**: :ref:`🔗` 绘制运动向量缓冲。由时间抗锯齿使用，能够修正在游戏过程中发生的运动。 +\ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26`` -绘制内部缓冲区而不是常规场景，因此可以看到将被后处理效果使用的每像素输出。 +绘制内部缓冲区而不是常规场景，因此可以看到将被后期处理效果使用的每像素输出。 + +\ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. rst-class:: classref-item-separator @@ -5907,6 +5959,22 @@ enum **Features**: :ref:`🔗` 画布项目的最大 Z 层。 +.. _class_RenderingServer_constant_CANVAS_LAYER_MIN: + +.. rst-class:: classref-constant + +**CANVAS_LAYER_MIN** = ``-2147483648`` :ref:`🔗` + +最小的画布层。 + +.. _class_RenderingServer_constant_CANVAS_LAYER_MAX: + +.. rst-class:: classref-constant + +**CANVAS_LAYER_MAX** = ``2147483647`` :ref:`🔗` + +最大的画布层。 + .. _class_RenderingServer_constant_MAX_GLOW_LEVELS: .. rst-class:: classref-constant @@ -6126,7 +6194,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`\ ) :ref:`🔗` -设置 DOF 散景图案的形状。可以使用不同的形状来达到艺术效果，或达到性能目标。有关可用选项的更多详细信息，请参阅 :ref:`DOFBokehShape`\ 。 +设置 DOF 散景图案的形状。可以使用不同的形状来达到艺术效果，或达到性能目标。 .. rst-class:: classref-item-separator @@ -6138,7 +6206,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, use_jitter\: :ref:`bool`\ ) :ref:`🔗` -将 DOF 模糊效果的质量级别设置为 :ref:`DOFBlurQuality` 中的选项之一。\ ``use_jitter`` 可用于抖动模糊过程中采集的样本，以隐藏伪影，代价是看起来更模糊。 +将 DOF 模糊效果的质量级别设置为 ``quality``\ 。\ ``use_jitter`` 可用于抖动模糊过程中采集的样本，以隐藏伪影，代价是看起来更模糊。 .. rst-class:: classref-item-separator @@ -6536,7 +6604,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 指向的 :ref:`CanvasItem` 上绘制一个三角形数组。渲染 :ref:`Line2D` 和 :ref:`StyleBoxFlat` 时内部使用。\ :ref:`canvas_item_add_triangle_array()` 非常灵活，但用起来要比 :ref:`canvas_item_add_polygon()` 复杂。 -\ **注意：**\ ``count`` 未使用，可以不指定。 +\ **注意：**\ 如果 ``count`` 设置为非负值，则仅绘制前 ``count * 3`` 个索引（对应于 ``count`` 个三角形）。否则将绘制所有索引。 .. rst-class:: classref-item-separator @@ -7120,7 +7188,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, mode\: :ref:`CanvasLightBlendMode`\ ) :ref:`🔗` -设置给定画布灯光的混合模式。选项见 :ref:`CanvasLightBlendMode`\ 。等价于 :ref:`Light2D.blend_mode`\ 。 +将给定画布灯光的混合模式设置为 ``mode``\ 。等价于 :ref:`Light2D.blend_mode`\ 。 .. rst-class:: classref-item-separator @@ -7228,7 +7296,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, mode\: :ref:`CanvasLightMode`\ ) :ref:`🔗` -光的模式，详见\ :ref:`CanvasLightMode`\ 。 +设置画布灯的模式。 .. rst-class:: classref-item-separator @@ -7264,7 +7332,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, filter\: :ref:`CanvasLightShadowFilter`\ ) :ref:`🔗` -设置画布灯的阴影过滤器，详见 :ref:`CanvasLightShadowFilter` 。 +设置画布灯的阴影过滤。 .. rst-class:: classref-item-separator @@ -7378,7 +7446,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) :ref:`🔗` -设置遮挡多边形剔除模式。详见 :ref:`CanvasOccluderPolygonCullMode` 。 +设置遮光器多边形的剔除模式。 .. rst-class:: classref-item-separator @@ -7848,6 +7916,8 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`\ 。 +\ **注意：**\ 该设置仅在使用 Forward+ 或 Mobile 渲染方法时有效，因为 Compatibility 使用的辉光实现方法不同。 + .. rst-class:: classref-item-separator ---- @@ -7948,6 +8018,18 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) :ref:`🔗` + +为指定的环境 RID 配置雾深度。仅在环境中雾模式为 :ref:`ENV_FOG_MODE_DEPTH` 时有效。详见 :ref:`Environment` 中的 ``fog_depth_*`` 属性。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_environment_set_glow: .. rst-class:: classref-method @@ -8248,9 +8330,13 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **get_current_rendering_driver_name**\ (\ ) |const| :ref:`🔗` -返回当前渲染驱动的名称，可以是 ``vulkan``\ 、\ ``d3d12``\ 、\ ``metal``\ 、\ ``opengl3``\ 、\ ``opengl3_es`` 或 ``opengl3_angle``\ 。另见 :ref:`get_current_rendering_method()`. +Returns the name of the current rendering driver. This can be ``vulkan``, ``d3d12``, ``metal``, ``opengl3``, ``opengl3_es``, or ``opengl3_angle``. See also :ref:`get_current_rendering_method()`. -渲染方法由 :ref:`ProjectSettings.rendering/rendering_device/driver` 决定，\ ``--rendering-driver`` 命令行参数会覆盖该项目设置，还会根据硬件应用自动回退。 +When :ref:`ProjectSettings.rendering/renderer/rendering_method` is ``forward_plus`` or ``mobile``, the rendering driver is determined by :ref:`ProjectSettings.rendering/rendering_device/driver`. + +When :ref:`ProjectSettings.rendering/renderer/rendering_method` is ``gl_compatibility``, the rendering driver is determined by :ref:`ProjectSettings.rendering/gl_compatibility/driver`. + +The rendering driver is also determined by the ``--rendering-driver`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware. .. rst-class:: classref-item-separator @@ -8314,7 +8400,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo`\ ) :ref:`🔗` -返回关于渲染引擎的统计信息，能够用于性能分析。能够查询的值的列表见 :ref:`RenderingInfo`\ 。另见 :ref:`viewport_get_render_info()`\ ，返回的是某个视口的相关信息。 +返回关于渲染引擎的统计信息，能够用于性能分析。另见 :ref:`viewport_get_render_info()`\ ，返回的是某个视口的相关信息。 \ **注意：**\ 部分值目前仅考虑 3D 渲染，例如绘制调用的数量。 @@ -8325,7 +8411,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) :ref:`🔗` -将阴影的投射设置设置为 :ref:`ShadowCastingSetting` 之一。相当于 :ref:`GeometryInstance3D.cast_shadow`\ 。 +设置阴影的投射设置。等价于 :ref:`GeometryInstance3D.cast_shadow`\ 。 .. rst-class:: classref-item-separator @@ -8708,7 +8794,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` -设置给定的 :ref:`InstanceFlags` 标志。更多细节请参阅 :ref:`InstanceFlags`\ 。 +将 ``instance`` 实例的 ``flag`` 标志的启用状态设置为 ``enabled``\ 。 .. rst-class:: classref-item-separator @@ -8804,20 +8890,6 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`\ ) :ref:`🔗` - -在当前物理周期阻止物理插值。 - -适用于将实例移动到新位置的场合，可以产生瞬时变化，而不是从先前位置进行插值。 - -.. rst-class:: classref-item-separator - ----- - .. _class_RenderingServer_method_instance_set_base: .. rst-class:: classref-method @@ -8878,18 +8950,6 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, interpolated\: :ref:`bool`\ ) :ref:`🔗` - -开启或关闭实例的物理插值。 - -.. rst-class:: classref-item-separator - ----- - .. _class_RenderingServer_method_instance_set_layer_mask: .. rst-class:: classref-method @@ -8974,6 +9034,18 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`\ ) :ref:`🔗` + +重置运动向量及其他插值数据。将网格从一个位置传送至另一个位置\ *之后*\ ，请使用该函数来避免重影问题。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_instances_cull_aabb: .. rst-class:: classref-method @@ -9046,7 +9118,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, mode\: :ref:`LightDirectionalShadowMode`\ ) :ref:`🔗` -设置该平行光的阴影模式。相当于 :ref:`DirectionalLight3D.directional_shadow_mode`\ 。有关选项，请参阅 :ref:`LightDirectionalShadowMode`\ 。 +设置平行光的阴影模式。相当于 :ref:`DirectionalLight3D.directional_shadow_mode`\ 。 .. rst-class:: classref-item-separator @@ -9166,7 +9238,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) :ref:`🔗` -设置指定的 3D 灯光参数。选项见 :ref:`LightParam`\ 。等价于 :ref:`Light3D.set_param()`\ 。 +设置指定的 3D 灯光参数。等价于 :ref:`Light3D.set_param()`\ 。 .. rst-class:: classref-item-separator @@ -9680,6 +9752,18 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **mesh_surface_get_format_index_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` + +返回具有给定 ``format`` 的网格的索引缓冲区的步幅。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride: .. rst-class:: classref-method @@ -9778,6 +9862,18 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` + +使用 ``data`` 中给定的数据更新网格表面的索引缓冲。数据应为 16 位或 32 位无符号整数，可以通过 :ref:`mesh_surface_get_format_index_stride()` 确定。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_mesh_surface_update_skin_region: .. rst-class:: classref-method @@ -10526,7 +10622,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, order\: :ref:`ParticlesDrawOrder`\ ) :ref:`🔗` -将粒子的绘制顺序设置为命名枚举 :ref:`ParticlesDrawOrder`\ 。选项见 :ref:`ParticlesDrawOrder`\ 。相当于 :ref:`GPUParticles3D.draw_order`\ 。 +设置粒子的绘制顺序。相当于 :ref:`GPUParticles3D.draw_order`\ 。 .. rst-class:: classref-item-separator @@ -11022,7 +11118,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) :ref:`🔗` -设置反射探针的更新频率。可以是一次，也可以是每一帧。参阅 :ref:`ReflectionProbeUpdateMode` 选项。 +设置反射探针的更新频率。可以是一次，也可以是每一帧。 .. rst-class:: classref-item-separator @@ -11214,7 +11310,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, code\: :ref:`String`\ ) :ref:`🔗` -设置着色器的源代码（更改后会出发重新编译）。 +设置着色器的源代码（更改后会触发重新编译）。 .. rst-class:: classref-item-separator @@ -11881,7 +11977,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **viewport_get_render_info**\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) :ref:`🔗` -返回关于渲染引擎的统计信息，能够用于性能分析。会区分不同的渲染阶段类型 ``type``\ ，每种类型都有相同的可查询信息 ``info``\ （不同的阶段会返回不同的值）。渲染阶段类型列表见 :ref:`ViewportRenderInfoType`\ ，能够查询的信息列表见 :ref:`ViewportRenderInfo`\ 。 +返回关于渲染引擎的统计信息，能够用于性能分析。会区分不同的渲染阶段类型 ``type``\ ，每种类型都有相同的可查询信息 ``info``\ （不同的阶段会返回不同的值）。 另见 :ref:`get_rendering_info()`\ ，返回的是所有视口的全局信息。 @@ -11892,7 +11988,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` -返回视口的更新模式。选项见 :ref:`ViewportUpdateMode` 常量。 +返回视口的更新模式。 \ **警告：**\ 在渲染线程之外的线程调用该方法会损害性能。 @@ -12005,6 +12101,8 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 和 :ref:`CANVAS_LAYER_MAX` 之间（含两端）。其他值都会发生环绕。 + .. rst-class:: classref-item-separator ---- @@ -12027,7 +12125,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, clear_mode\: :ref:`ViewportClearMode`\ ) :ref:`🔗` -设置视口的清除模式。可选项见 :ref:`ViewportClearMode`\ 。 +设置视口的清空模式。 .. rst-class:: classref-item-separator @@ -12039,7 +12137,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, draw\: :ref:`ViewportDebugDraw`\ ) :ref:`🔗` -设置视口的调试绘图模式。可选项见 :ref:`ViewportDebugDraw`\ 。 +设置视口的调试绘图模式。 .. rst-class:: classref-item-separator @@ -12051,7 +12149,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` -设置视口的默认纹理过滤模式，视口由 ``viewport`` RID 指定。选项见 :ref:`CanvasItemTextureFilter`\ 。 +设置视口的默认纹理过滤模式，视口由 ``viewport`` RID 指定。 .. rst-class:: classref-item-separator @@ -12063,7 +12161,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` -设置视口的默认纹理重复模式，视口由 ``viewport`` RID 指定。选项见 :ref:`CanvasItemTextureRepeat`\ 。 +设置视口的默认纹理重复模式，视口由 ``viewport`` RID 指定。 .. rst-class:: classref-item-separator @@ -12147,7 +12245,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` -设置 RID 为 ``viewport`` 的视口的 2D/画布多重采样抗锯齿模式。选项见 :ref:`ViewportMSAA`\ 。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d` 或 :ref:`Viewport.msaa_2d`\ 。 +设置视口的 2D/画布多重采样抗锯齿模式，视口由 ``viewport`` RID 指定。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d` 或 :ref:`Viewport.msaa_2d`\ 。 .. rst-class:: classref-item-separator @@ -12159,7 +12257,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` -设置 RID 为 ``viewport`` 的视口的 3D 多重采样抗锯齿模式。选项见 :ref:`ViewportMSAA`\ 。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d` 或 :ref:`Viewport.msaa_3d`\ 。 +设置视口的 3D 多重采样抗锯齿模式，视口由 ``viewport`` RID 指定。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d` 或 :ref:`Viewport.msaa_3d`\ 。 .. rst-class:: classref-item-separator @@ -12369,7 +12467,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, update_mode\: :ref:`ViewportUpdateMode`\ ) :ref:`🔗` -设置应更新视口的时间。可选项请参阅 :ref:`ViewportUpdateMode` 。 +设置视口应在何时更新。 .. rst-class:: classref-item-separator @@ -12381,7 +12479,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, enable\: :ref:`bool`\ ) :ref:`🔗` -如果为 ``true``\ ，则在指定的视口上启用去条带。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding` 或 :ref:`Viewport.use_debanding`\ 。 +等价于 :ref:`Viewport.use_debanding`\ 。另见 :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`\ 。 .. rst-class:: classref-item-separator @@ -12393,9 +12491,11 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()`, enabled\: :ref:`bool`\ ) :ref:`🔗` -如果为 ``true``\ ，2D 渲染将使用与 3D 帧缓冲区的位深度匹配的高动态范围（HDR）格式帧缓冲区。当使用 Forward+ 渲染器时，这将是一个 ``RGBA16`` 帧缓冲区，而当使用 Mobile 渲染器时，它将是一个 ``RGB10_A2`` 帧缓冲区。此外，2D 渲染将在线性色彩空间中进行，并在位块传输到屏幕之前（如果视口被连接到屏幕）立即转换为 sRGB 空间。实际上，这意味着视口的最终结果不会被钳制在 ``0-1`` 范围内，并且可以在不进行色彩空间调整的情况下被用于 3D 渲染。这使得 2D 渲染能够利用需要高动态范围的效果（例如 2D 辉光），并显著改善需要高度详细渐变的效果的外观。该设置与 :ref:`Viewport.use_hdr_2d` 效果相同。 +If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility renderer, this will be an ``RGBA16`` framebuffer. When using the Mobile renderer, it will be an ``RGB10_A2`` framebuffer. -\ **注意：**\ 使用 Compatibility 渲染器时该设置不起作用，出于性能原因，该渲染器始终在低动态范围内渲染。 +Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). + +Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. .. rst-class:: classref-item-separator @@ -12740,6 +12840,7 @@ RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.use_two_bounces` 值。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenebuffers.rst b/classes/zh_CN/class_renderscenebuffers.rst index f62b7fffc6..97a6ce349a 100644 --- a/classes/zh_CN/class_renderscenebuffers.rst +++ b/classes/zh_CN/class_renderscenebuffers.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneBuffers.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffers.xml. .. _class_RenderSceneBuffers: @@ -55,6 +55,7 @@ RenderSceneBuffers 当关联的视口配置更改时，渲染服务器会调用该方法。它将丢弃旧的缓冲区并重新创建使用的内部缓冲区。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenebuffersconfiguration.rst b/classes/zh_CN/class_renderscenebuffersconfiguration.rst index 74fa50f9cb..d8fe8a02e7 100644 --- a/classes/zh_CN/class_renderscenebuffersconfiguration.rst +++ b/classes/zh_CN/class_renderscenebuffersconfiguration.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneBuffersConfiguration.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersConfiguration.xml. .. _class_RenderSceneBuffersConfiguration: @@ -227,6 +227,7 @@ RenderSceneBuffersConfiguration 渲染的视图数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenebuffersextension.rst b/classes/zh_CN/class_renderscenebuffersextension.rst index 79791a15cb..8c548f9386 100644 --- a/classes/zh_CN/class_renderscenebuffersextension.rst +++ b/classes/zh_CN/class_renderscenebuffersextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneBuffersExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersExtension.xml. .. _class_RenderSceneBuffersExtension: @@ -107,6 +107,7 @@ RenderSceneBuffersExtension 在 GDExtension 中实现该功能以对去色带标志的更改做出反应。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenebuffersrd.rst b/classes/zh_CN/class_renderscenebuffersrd.rst index 8439625963..fa2b6cfb72 100644 --- a/classes/zh_CN/class_renderscenebuffersrd.rst +++ b/classes/zh_CN/class_renderscenebuffersrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneBuffersRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersRD.xml. .. _class_RenderSceneBuffersRD: @@ -431,6 +431,7 @@ RenderSceneBuffersRD 如果存在使用该名称的缓冲纹理，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenedata.rst b/classes/zh_CN/class_renderscenedata.rst index 149445c2ff..13550b2818 100644 --- a/classes/zh_CN/class_renderscenedata.rst +++ b/classes/zh_CN/class_renderscenedata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneData.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneData.xml. .. _class_RenderSceneData: @@ -131,6 +131,7 @@ RenderSceneData \ **注意：**\ 如果渲染单个视图，则返回相机投影。如果渲染多个视图，则这将返回给定视图的投影，包括眼睛偏移。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenedataextension.rst b/classes/zh_CN/class_renderscenedataextension.rst index c352611ff4..095ef4cd4e 100644 --- a/classes/zh_CN/class_renderscenedataextension.rst +++ b/classes/zh_CN/class_renderscenedataextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneDataExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneDataExtension.xml. .. _class_RenderSceneDataExtension: @@ -121,6 +121,7 @@ RenderSceneDataExtension 在 GDExtension 中实现时请返回 ``view`` 视图的视图 :ref:`Projection`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_renderscenedatard.rst b/classes/zh_CN/class_renderscenedatard.rst index 1bc1734df8..ffdda60715 100644 --- a/classes/zh_CN/class_renderscenedatard.rst +++ b/classes/zh_CN/class_renderscenedatard.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RenderSceneDataRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneDataRD.xml. .. _class_RenderSceneDataRD: @@ -24,6 +24,7 @@ RenderSceneDataRD \ **注意：**\ 这是一个内部渲染服务器对象，不要从脚本中实例化它。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resource.rst b/classes/zh_CN/class_resource.rst index 8bc7e654a4..44cf4ab8eb 100644 --- a/classes/zh_CN/class_resource.rst +++ b/classes/zh_CN/class_resource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Resource.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Resource.xml. .. _class_Resource: @@ -12,7 +12,7 @@ Resource **继承：** :ref:`RefCounted` **<** :ref:`Object` -**派生：** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**派生：** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`FoldableGroup`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` 可序列化对象的基类。 @@ -64,39 +64,41 @@ Resource .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_rid`\ (\ ) |virtual| |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_reset_state`\ (\ ) |virtual| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_path_cache`\ (\ path\: :ref:`String`\ ) |virtual| |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_setup_local_to_scene`\ (\ ) |virtual| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`duplicate`\ (\ subresources\: :ref:`bool` = false\ ) |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`emit_changed`\ (\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`generate_scene_unique_id`\ (\ ) |static| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_id_for_path`\ (\ path\: :ref:`String`\ ) |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_local_scene`\ (\ ) |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_built_in`\ (\ ) |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reset_state`\ (\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_id_for_path`\ (\ path\: :ref:`String`, id\: :ref:`String`\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_path_cache`\ (\ path\: :ref:`String`\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`setup_local_to_scene`\ (\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`take_over_path`\ (\ path\: :ref:`String`\ ) | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_rid`\ (\ ) |virtual| |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reset_state`\ (\ ) |virtual| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_path_cache`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_setup_local_to_scene`\ (\ ) |virtual| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`duplicate_deep`\ (\ deep_subresources_mode\: :ref:`DeepDuplicateMode` = 1\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit_changed`\ (\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`generate_scene_unique_id`\ (\ ) |static| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_id_for_path`\ (\ path\: :ref:`String`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_local_scene`\ (\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_built_in`\ (\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_state`\ (\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_id_for_path`\ (\ path\: :ref:`String`, id\: :ref:`String`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_path_cache`\ (\ path\: :ref:`String`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`setup_local_to_scene`\ (\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`take_over_path`\ (\ path\: :ref:`String`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -137,6 +139,45 @@ Resource .. rst-class:: classref-descriptions-group +枚举 +---- + +.. _enum_Resource_DeepDuplicateMode: + +.. rst-class:: classref-enumeration + +enum **DeepDuplicateMode**: :ref:`🔗` + +.. _class_Resource_constant_DEEP_DUPLICATE_NONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`DeepDuplicateMode` **DEEP_DUPLICATE_NONE** = ``0`` + +完全不复制子资源。即使在深层复制时也很有用，因为可以在复制所有数组和字典的同时，仍然指向原始资源。 + +.. _class_Resource_constant_DEEP_DUPLICATE_INTERNAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`DeepDuplicateMode` **DEEP_DUPLICATE_INTERNAL** = ``1`` + +仅复制不具备路径的子资源以及使用场景本地化路径的子资源。 + +.. _class_Resource_constant_DEEP_DUPLICATE_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`DeepDuplicateMode` **DEEP_DUPLICATE_ALL** = ``2`` + +复制所有子资源，即便使用的是非本地路径。换句话说，即便是单独保存的大型资源也会复制。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 属性说明 -------- @@ -243,7 +284,7 @@ Resource |void| **_reset_state**\ (\ ) |virtual| :ref:`🔗` -对于使用可变数量属性的资源，无论是通过 :ref:`Object._validate_property()` 还是 :ref:`Object._get_property_list()` 使用，都应实现该方法正确清除资源的状态。 +如果资源在未导出的属性中存储状态，例如通过 :ref:`Object._validate_property()` 或 :ref:`Object._get_property_list()` 存储，则必须实现该方法进行状态的清空。 .. rst-class:: classref-item-separator @@ -255,7 +296,7 @@ Resource |void| **_set_path_cache**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -将资源的路径设为 ``path``\ ，不涉及资源缓存。 +可以覆盖此方法，从而在对象的 :ref:`set_path_cache()` 被调用后执行额外的逻辑。 .. rst-class:: classref-item-separator @@ -274,9 +315,9 @@ Resource :: extends Resource - + var damage = 0 - + func _setup_local_to_scene(): damage = randi_range(10, 40) @@ -288,22 +329,38 @@ Resource .. rst-class:: classref-method -:ref:`Resource` **duplicate**\ (\ subresources\: :ref:`bool` = false\ ) |const| :ref:`🔗` +:ref:`Resource` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| :ref:`🔗` 制作该资源的副本，返回资源中，\ ``export`` 的属性以及 :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` 的属性都会从原始资源中复制。 -如果 ``subresources`` 为 ``false``\ ，则返回的是浅拷贝；子资源中的嵌套资源不会被复制，并与原始资源共享（有一个例外；见下文）。如果 ``subresources`` 为 ``true``\ ，则返回的是深拷贝；嵌套子资源将被复制，并且不会共享（有两个例外；见下文）。 +如果 ``deep`` 为 ``false``\ ，则会返回\ **浅拷贝**\ ：嵌套的 :ref:`Array`\ 、\ :ref:`Dictionary`\ 、\ **Resource** 属性不会发生复制，与原资源共享。 -\ ``subresources`` 通常被遵守，但有以下例外： +如果 ``deep`` 为 ``true``\ ，则会返回\ **深拷贝**\ ：嵌套的数组、字典和紧缩数组都会发生（递归）复制。内部的 **Resource** 只会在本地时进行复制，类似于对 :ref:`duplicate_deep()` 使用 :ref:`DEEP_DUPLICATE_INTERNAL`\ 。 -- 带有 :ref:`@GlobalScope.PROPERTY_USAGE_ALWAYS_DUPLICATE` 标志的子资源属性始终会被复制。 +例外如下： + +- 带有 :ref:`@GlobalScope.PROPERTY_USAGE_ALWAYS_DUPLICATE` 标志的子资源属性始终会被复制（是否递归取决于 ``deep``\ ）。 - 带有 :ref:`@GlobalScope.PROPERTY_USAGE_NEVER_DUPLICATE` 标志的子资源属性始终不会被复制。 -- :ref:`Array` 和 :ref:`Dictionary` 属性内的子资源始终不会被复制。 - \ **注意：**\ 对于自定义资源，如果定义 :ref:`Object._init()` 时使用了必填的参数，则此方法会失败。 +\ **注意：**\ 复制时如果将 ``deep`` 设置为 ``true``\ ，则在复制过程中发现的每个资源，包括调用该方法的资源，都只会发生一次复制，在副本中可以对其存在多次引用。例如你复制的资源 A 里正好对资源 B 存在两个引用，那么新的资源 A' 就会引用新的资源 B' 两次。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Resource_method_duplicate_deep: + +.. rst-class:: classref-method + +:ref:`Resource` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`DeepDuplicateMode` = 1\ ) |const| :ref:`🔗` + +深度复制该资源，类似于 :ref:`duplicate()`\ ``(true)``\ ，但可以进一步控制子资源的处理方式。 + +\ ``deep_subresources_mode`` 必须是 :ref:`DeepDuplicateMode` 中的值。 + .. rst-class:: classref-item-separator ---- @@ -348,9 +405,9 @@ Resource :ref:`String` **get_id_for_path**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` -返回资源缓存中路径 ``path`` 对应资源的唯一标识符。如果资源尚未加载和缓存，则会返回空字符串。 +根据场景唯一 ID 的内部缓存，返回位于 ``path`` 的场景中该资源的 ID。如果没有对应的条目则返回空字符串。适用于扩展 :ref:`ResourceFormatLoader` 和 :ref:`ResourceFormatSaver` 实现对版本控制系统友好的自定义资源格式时保持场景唯一 ID 一致。 -\ **注意：**\ 该方法仅在编辑器环境运行时实现。运行时会返回空字符串。 +\ **注意：**\ 该方法仅在运行于编辑器上下文时实现。运行时返回空字符串。 .. rst-class:: classref-item-separator @@ -386,7 +443,7 @@ Resource :ref:`bool` **is_built_in**\ (\ ) |const| :ref:`🔗` -如果资源为（引擎的）内置资源则返回 ``true``\ ，为用户定义资源则返回 ``false``\ 。 +如果资源是作为其他资源文件中的一部分保存到磁盘上的，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -398,7 +455,7 @@ Resource |void| **reset_state**\ (\ ) :ref:`🔗` -如果资源通过 :ref:`Object._validate_property()` 或 :ref:`Object._get_property_list()` 实现了可变数量的属性，请覆盖 :ref:`_reset_state()` 从而正确清空资源的状态。 +清空资源中未导出的属性。另见 :ref:`_reset_state()`\ 。适合在通过扩展 :ref:`ResourceFormatLoader` 和 :ref:`ResourceFormatSaver` 实现自定义资源格式时使用。 .. rst-class:: classref-item-separator @@ -410,9 +467,9 @@ Resource |void| **set_id_for_path**\ (\ path\: :ref:`String`, id\: :ref:`String`\ ) :ref:`🔗` -在资源缓存中将位于 ``path`` 的资源的唯一标识符设置为 ``id``\ 。如果唯一标识符为空且存在使用 ``path`` 的缓存条目，则会移除该缓存条目。 +场景唯一 ID 的内部缓存，针对位于 ``path`` 的场景将该资源的 ID 设置为 ``id``\ 。如果 ``id`` 为空，则会清空 ``path`` 对应的缓存条目。适用于扩展 :ref:`ResourceFormatLoader` 和 :ref:`ResourceFormatSaver` 实现对版本控制系统友好的自定义资源格式时保持场景唯一 ID 一致。 -\ **注意：**\ 该方法仅在编辑器上下文中实现。 +\ **注意：**\ 该方法仅在运行于编辑器上下文时实现。 .. rst-class:: classref-item-separator @@ -424,7 +481,7 @@ Resource |void| **set_path_cache**\ (\ path\: :ref:`String`\ ) :ref:`🔗` -将资源的路径设为 ``path``\ ，不涉及资源缓存。 +将资源的路径设置为 ``path``\ ，不涉及资源缓存。适用于扩展 :ref:`ResourceFormatLoader` 和 :ref:`ResourceFormatSaver` 实现自定义资源格式时处理 :ref:`CacheMode` 的值。 .. rst-class:: classref-item-separator @@ -453,6 +510,7 @@ Resource 将 :ref:`resource_path` 设置为 ``path``\ ，可能会覆盖这个路径对应的已有缓存条目。后续尝试通过路径加载覆盖后的资源时，会返回这个资源。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceformatloader.rst b/classes/zh_CN/class_resourceformatloader.rst index c507cfcb4a..a9366c8c26 100644 --- a/classes/zh_CN/class_resourceformatloader.rst +++ b/classes/zh_CN/class_resourceformatloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceFormatLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceFormatLoader.xml. .. _class_ResourceFormatLoader: @@ -155,9 +155,25 @@ enum **CacheMode**: :ref:`🔗` :ref:`PackedStringArray` **_get_dependencies**\ (\ path\: :ref:`String`, add_types\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` -如果实现，则获取给定资源的依赖项。如果 ``add_types`` 为 ``true``\ ，路径应追加 ``::TypeName``\ ，其中 ``TypeName`` 是依赖项的类名。 +应当返回路径为 ``path`` 的资源的依赖项。每个依赖项都是由一至三部分构成的字符串，使用 ``::`` 分隔，省略末尾为空的部分： -\ **注意：**\ 脚本定义的自定义资源类型并不为 :ref:`ClassDB` 所知，因此可能只能为它们返回 ``"Resource"``\ 。 +- 如果资源有 UID 则第一部分包含的应当是 UID。否则包含的应当是文件的路径。 + +- 如果 ``add_types`` 为 ``true``\ ，则第二部分包含的应当是依赖项的类名。否则应当为空。 + +- 如果资源有 UID 则第三部分包含的应当是回退路径。否则应当为空。 + +:: + + func _get_dependencies(path, add_types): + return [ + "uid://fqgvuwrkuixh::Script::res://script.gd", + "uid://fqgvuwrkuixh::::res://script.gd", + "res://script.gd::Script", + "res://script.gd", + ] + +\ **注意：**\ :ref:`ClassDB` 并不知道由脚本定义的自定义资源类型，因此类名可以使用 ``"Resource"``\ 。 .. rst-class:: classref-item-separator @@ -266,6 +282,7 @@ enum **CacheMode**: :ref:`🔗` 成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回 :ref:`Error` 常量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceformatsaver.rst b/classes/zh_CN/class_resourceformatsaver.rst index 0fe033551f..64dc6625b4 100644 --- a/classes/zh_CN/class_resourceformatsaver.rst +++ b/classes/zh_CN/class_resourceformatsaver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceFormatSaver.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceFormatSaver.xml. .. _class_ResourceFormatSaver: @@ -113,6 +113,7 @@ ResourceFormatSaver 为给定 ``path`` 处的资源设置新的 UID。成功时返回 :ref:`@GlobalScope.OK`\ ，失败时返回 :ref:`Error` 常量。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporter.rst b/classes/zh_CN/class_resourceimporter.rst index 087c408516..402a8865d9 100644 --- a/classes/zh_CN/class_resourceimporter.rst +++ b/classes/zh_CN/class_resourceimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporter.xml. .. _class_ResourceImporter: @@ -12,7 +12,7 @@ ResourceImporter **继承：** :ref:`RefCounted` **<** :ref:`Object` -**派生：** :ref:`EditorImportPlugin`, :ref:`ResourceImporterBitMap`, :ref:`ResourceImporterBMFont`, :ref:`ResourceImporterCSVTranslation`, :ref:`ResourceImporterDynamicFont`, :ref:`ResourceImporterImage`, :ref:`ResourceImporterImageFont`, :ref:`ResourceImporterLayeredTexture`, :ref:`ResourceImporterMP3`, :ref:`ResourceImporterOBJ`, :ref:`ResourceImporterOggVorbis`, :ref:`ResourceImporterScene`, :ref:`ResourceImporterShaderFile`, :ref:`ResourceImporterTexture`, :ref:`ResourceImporterTextureAtlas`, :ref:`ResourceImporterWAV` +**派生：** :ref:`EditorImportPlugin`, :ref:`ResourceImporterBitMap`, :ref:`ResourceImporterBMFont`, :ref:`ResourceImporterCSVTranslation`, :ref:`ResourceImporterDynamicFont`, :ref:`ResourceImporterImage`, :ref:`ResourceImporterImageFont`, :ref:`ResourceImporterLayeredTexture`, :ref:`ResourceImporterMP3`, :ref:`ResourceImporterOBJ`, :ref:`ResourceImporterOggVorbis`, :ref:`ResourceImporterScene`, :ref:`ResourceImporterShaderFile`, :ref:`ResourceImporterSVG`, :ref:`ResourceImporterTexture`, :ref:`ResourceImporterTextureAtlas`, :ref:`ResourceImporterWAV` 资源导入器的基类。 @@ -30,6 +30,18 @@ ResourceImporter - :doc:`导入插件 <../tutorials/plugins/editor/import_plugins>` +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_build_dependencies`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. rst-class:: classref-section-separator ---- @@ -61,7 +73,36 @@ enum **ImportOrder**: :ref:`🔗` 场景的导入顺序，确保场景被导入在所有其他核心资源（如纹理）\ *之后*\ 。自定义导入器的导入顺序一般应低于\ ``100``\ ，以避免导入依赖自定义资源的场景时出现问题。 +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_ResourceImporter_private_method__get_build_dependencies: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_build_dependencies**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` + +当引擎编译配置文件编辑器想要检查导入资源所需的构建选项时会调用此方法。例如， :ref:`ResourceImporterDynamicFont` 有一个名为 :ref:`ResourceImporterDynamicFont.multichannel_signed_distance_field` 的属性，该属性要求引擎在构建时必须启用“msdfgen”模块。如果该资源恰好是自定义的资源，则会像这样处理： + +:: + + func _get_build_dependencies(path): + var resource = load(path) + var dependencies = PackedStringArray() + + if resource.multichannel_signed_distance_field: + dependencies.push_back("module_msdfgen_enabled") + + return dependencies + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterbitmap.rst b/classes/zh_CN/class_resourceimporterbitmap.rst index 501e50e6ad..ea0133cdf5 100644 --- a/classes/zh_CN/class_resourceimporterbitmap.rst +++ b/classes/zh_CN/class_resourceimporterbitmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterBitMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBitMap.xml. .. _class_ResourceImporterBitMap: @@ -76,6 +76,7 @@ ResourceImporterBitMap 用于确定哪些位应被视为启用或禁用的阈值。另见 :ref:`create_from`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterbmfont.rst b/classes/zh_CN/class_resourceimporterbmfont.rst index 19b02e4ada..72276eb592 100644 --- a/classes/zh_CN/class_resourceimporterbmfont.rst +++ b/classes/zh_CN/class_resourceimporterbmfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterBMFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBMFont.xml. .. _class_ResourceImporterBMFont: @@ -90,6 +90,7 @@ BMFont 格式是由 `BMFont `__ 程 字体缩放模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimportercsvtranslation.rst b/classes/zh_CN/class_resourceimportercsvtranslation.rst index 24d979b78f..ccc821328c 100644 --- a/classes/zh_CN/class_resourceimportercsvtranslation.rst +++ b/classes/zh_CN/class_resourceimportercsvtranslation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterCSVTranslation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterCSVTranslation.xml. .. _class_ResourceImporterCSVTranslation: @@ -82,6 +82,7 @@ ResourceImporterCSVTranslation 在 CSV 文件中使用的分隔符。该默认值符合常见的 CSV 约定。制表符分隔值有时被称为 TSV 文件。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterdynamicfont.rst b/classes/zh_CN/class_resourceimporterdynamicfont.rst index 557a47bb44..ce9555e489 100644 --- a/classes/zh_CN/class_resourceimporterdynamicfont.rst +++ b/classes/zh_CN/class_resourceimporterdynamicfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterDynamicFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterDynamicFont.xml. .. _class_ResourceImporterDynamicFont: @@ -61,6 +61,8 @@ ResourceImporterDynamicFont +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Dictionary` | :ref:`language_support` | ``{}`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``8`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -223,6 +225,18 @@ ResourceImporterDynamicFont ---- +.. _class_ResourceImporterDynamicFont_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +如果设为 ``true``\ ，则绘制彩色字形时会应用颜色调制，否则只会对灰度字形应用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterDynamicFont_property_msdf_pixel_range: .. rst-class:: classref-property @@ -279,7 +293,7 @@ MSDF 字体渲染可以与 :ref:`generate_mipmaps` **oversampling** = ``0.0`` :ref:`🔗` -如果设为大于 ``0.0`` 的值，则会覆盖字体的过采样系数。可以用来在保持字体物理大小的前提下，使用比原计划更高或更低的分辨率渲染。大多数情况下应该保持为 ``0.0``\ 。 +如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。 .. rst-class:: classref-item-separator @@ -328,6 +342,7 @@ MSDF 字体渲染可以与 :ref:`generate_mipmaps` **<** :ref:`RefCounted` **<** :ref:`Object` -导入图像以用于脚本编写，但不具有渲染功能。 +导入图像供脚本使用，不具有渲染功能。 .. rst-class:: classref-introduction-group @@ -29,6 +29,7 @@ ResourceImporterImage - :doc:`导入图像 <../tutorials/assets_pipeline/importing_images>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterimagefont.rst b/classes/zh_CN/class_resourceimporterimagefont.rst index 5fc058cb82..b22f38175b 100644 --- a/classes/zh_CN/class_resourceimporterimagefont.rst +++ b/classes/zh_CN/class_resourceimporterimagefont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterImageFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterImageFont.xml. .. _class_ResourceImporterImageFont: @@ -107,7 +107,7 @@ ResourceImporterImageFont 指定范围时如果在后面加上三个用空格分隔的整数值，就可以自定义字符的前进量和偏移（额外前进量、X 偏移量、Y 偏移量）。例如 ``'a'-'b' 4 5 2`` 就是将 `a` 和 `b` 这两个字符的前进量设为 ``char_width + 4`` 并将偏移量设为 ``Vector2(5, 2)``\ 。 -请确保 :ref:`character_ranges` 不超过 :ref:`columns` \* :ref:`rows` 定义的数量。否则字体将无法导入。 +\ **注意：**\ 总字符数必须不超过 :ref:`columns` 与 :ref:`rows` 的乘积。否则字体将无法导入。 **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. @@ -212,6 +212,7 @@ ResourceImporterImageFont 字体缩放模式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterlayeredtexture.rst b/classes/zh_CN/class_resourceimporterlayeredtexture.rst index 719bd0bbe2..2b78667c8b 100644 --- a/classes/zh_CN/class_resourceimporterlayeredtexture.rst +++ b/classes/zh_CN/class_resourceimporterlayeredtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterLayeredTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterLayeredTexture.xml. .. _class_ResourceImporterLayeredTexture: @@ -36,23 +36,27 @@ ResourceImporterLayeredTexture .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/mode` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`mipmaps/generate` | ``true`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`slices/arrangement` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/mode` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/rdo_quality_loss` | ``0.0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/uastc_level` | ``0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`mipmaps/generate` | ``true`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`slices/arrangement` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -153,6 +157,34 @@ BPTC 和 ASTC 支持 HDR 纹理的 VRAM 压缩，但 S3TC 和 ETC2 不支持（ ---- +.. _class_ResourceImporterLayeredTexture_property_compress/rdo_quality_loss: + +.. rst-class:: classref-property + +:ref:`float` **compress/rdo_quality_loss** = ``0.0`` :ref:`🔗` + +如果大于等于 ``0.01``\ ，则会启用率-失真优化（Rate-Distortion Optimization、RDO）来降低文件大小。值越高文件大小越小，但质量也越低。 + +\ **注意：**\ 启用 RDO 会显著增加编码时间，在图像较大时尤为明显。 + +如果想要进一步降低文件大小，请参阅 :ref:`ProjectSettings.rendering/textures/basis_universal/rdo_dict_size` 和 :ref:`ProjectSettings.rendering/textures/basis_universal/zstd_supercompression_level`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/uastc_level: + +.. rst-class:: classref-property + +:ref:`int` **compress/uastc_level** = ``0`` :ref:`🔗` + +UASTC 编码级别。值越高质量越好，但编码耗时更长。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterLayeredTexture_property_mipmaps/generate: .. rst-class:: classref-property @@ -194,6 +226,7 @@ BPTC 和 ASTC 支持 HDR 纹理的 VRAM 压缩，但 S3TC 和 ETC2 不支持（ 控制立方体贴图纹理的内部布局方式。使用高分辨率立方体贴图时，与 **1×6** 和 **6×1** 相比，\ **2×3** and **3×2** 不太容易超出硬件纹理大小限制。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimportermp3.rst b/classes/zh_CN/class_resourceimportermp3.rst index 88abf84ecd..3e7ceefc9e 100644 --- a/classes/zh_CN/class_resourceimportermp3.rst +++ b/classes/zh_CN/class_resourceimportermp3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/minimp3/doc_classes/ResourceImporterMP3.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/ResourceImporterMP3.xml. .. _class_ResourceImporterMP3: @@ -130,6 +130,7 @@ MP3 比 :ref:`ResourceImporterWAV` 需要更多的 CP \ **高级导入设置**\ 对话框中为 :ref:`loop_offset` 提供了更方便的编辑器，因为它可以让你预览更改，且无需重新导入音频。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterobj.rst b/classes/zh_CN/class_resourceimporterobj.rst index 8ce34c0eea..c1970e0c3b 100644 --- a/classes/zh_CN/class_resourceimporterobj.rst +++ b/classes/zh_CN/class_resourceimporterobj.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterOBJ.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterOBJ.xml. .. _class_ResourceImporterOBJ: @@ -162,6 +162,7 @@ ResourceImporterOBJ 按指定值缩放网格数据。这可被用于解决缩放错误的网格，而无需修改源文件。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporteroggvorbis.rst b/classes/zh_CN/class_resourceimporteroggvorbis.rst index be752bfe5e..f409fc23af 100644 --- a/classes/zh_CN/class_resourceimporteroggvorbis.rst +++ b/classes/zh_CN/class_resourceimporteroggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml. .. _class_ResourceImporterOggVorbis: @@ -177,6 +177,7 @@ Ogg Vorbis 比 :ref:`ResourceImporterWAV` 需要更 从给定的文件路径新建 :ref:`AudioStreamOggVorbis` 实例。文件必须为 Ogg Vorbis 格式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterscene.rst b/classes/zh_CN/class_resourceimporterscene.rst index 449fcf08ac..44c85d9dd8 100644 --- a/classes/zh_CN/class_resourceimporterscene.rst +++ b/classes/zh_CN/class_resourceimporterscene.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterScene.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterScene.xml. .. _class_ResourceImporterScene: @@ -12,7 +12,7 @@ ResourceImporterScene **继承：** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` -导入 glTF、FBX、Collada 或 Blender 3D 场景。 +导入 glTF、FBX、COLLADA 或 Blender 3D 场景。 .. rst-class:: classref-introduction-group @@ -55,6 +55,12 @@ ResourceImporterScene +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`import_script/path` | ``""`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`materials/extract` | ``0`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`materials/extract_format` | ``0`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`materials/extract_path` | ``""`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`meshes/create_shadow_meshes` | ``true`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`meshes/ensure_tangents` | ``true`` | @@ -75,8 +81,12 @@ ResourceImporterScene +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`nodes/root_scale` | ``1.0`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Script` | :ref:`nodes/root_script` | ``null`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`nodes/root_type` | ``""`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`nodes/use_name_suffixes` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`nodes/use_node_type_suffixes` | ``true`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`skins/use_named_skins` | ``true`` | @@ -175,6 +185,54 @@ ResourceImporterScene ---- +.. _class_ResourceImporterScene_property_materials/extract: + +.. rst-class:: classref-property + +:ref:`int` **materials/extract** = ``0`` :ref:`🔗` + +材质提取模式。 + +- ``0 (Keep Internal)``\ ，不提取材质。 + +- ``1 (Extract Once)``\ ，提取一次材质，后续导入时重用。 + +- ``2 (Extract and Overwrite)``\ ，每次导入都提取并覆盖材质。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_materials/extract_format: + +.. rst-class:: classref-property + +:ref:`int` **materials/extract_format** = ``0`` :ref:`🔗` + +提取材质的文件格式。 + +- ``0 (Text)``\ ，文本文件格式（\ ``*.tres``\ ）。 + +- ``1 (Binary)``\ ，二进制文件格式（\ ``*.res``\ ）。 + +- ``2 (Material)``\ ，二进制文件格式（\ ``*.material``\ ）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_materials/extract_path: + +.. rst-class:: classref-property + +:ref:`String` **materials/extract_path** = ``""`` :ref:`🔗` + +提取材质的保存路径。留空时使用源场景路径。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterScene_property_meshes/create_shadow_meshes: .. rst-class:: classref-property @@ -299,6 +357,18 @@ ResourceImporterScene ---- +.. _class_ResourceImporterScene_property_nodes/root_script: + +.. rst-class:: classref-property + +:ref:`Script` **nodes/root_script** = ``null`` :ref:`🔗` + +如果设为有效的脚本，则会将该脚本附加到导入后的场景的根节点上。如果根节点的类型与脚本不兼容，则会将根节点替换为与脚本兼容的类型。也可以对场景中的其他非网格节点使用该设置，为他们附加脚本。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterScene_property_nodes/root_type: .. rst-class:: classref-property @@ -311,13 +381,25 @@ ResourceImporterScene ---- +.. _class_ResourceImporterScene_property_nodes/use_name_suffixes: + +.. rst-class:: classref-property + +:ref:`bool` **nodes/use_name_suffixes** = ``true`` :ref:`🔗` + +如果为 ``true``\ ，则会使用导入的节点、资源等对象的名称后缀来确定类型和属性，例如 ``-noimp`` 可以跳过节点和动画的导入、\ ``-alpha`` 可以启用材质的 Alpha 透明、\ ``-vcol`` 可以启用材质的顶点颜色。禁用该选项会让编辑器导入的文件更接近原始文件，更类似于在运行时导入文件。详见\ :doc:`《使用名称后缀自定义节点类型》 <../tutorials/assets_pipeline/importing_3d_scenes/node_type_customization>`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterScene_property_nodes/use_node_type_suffixes: .. rst-class:: classref-property :ref:`bool` **nodes/use_node_type_suffixes** = ``true`` :ref:`🔗` -如果为 ``true``\ ，则会使用节点名称的后缀来确定节点类型，例如 ``-col`` 表示碰撞形状。禁用该选项会让编辑器导入的文件更接近原始文件，更类似于在运行时导入文件。详见\ :doc:`《使用名称后缀自定义节点类型》 <../tutorials/assets_pipeline/importing_3d_scenes/node_type_customization>`\ 。 +如果为 ``true``\ ，则会使用节点名称的后缀来确定节点类型，例如 ``-col`` 表示碰撞形状。仅在 :ref:`nodes/use_name_suffixes` 为 ``true`` 时使用。禁用该选项会让编辑器导入的文件更接近原始文件，更类似于在运行时导入文件。详见\ :doc:`《使用名称后缀自定义节点类型》 <../tutorials/assets_pipeline/importing_3d_scenes/node_type_customization>`\ 。 .. rst-class:: classref-item-separator @@ -340,6 +422,7 @@ ResourceImporterScene 总之，这些信息足以告诉 Godot 如何使用 :ref:`Skeleton3D` 节点中的骨骼姿势来渲染每个 :ref:`MeshInstance3D` 的网格。请注意，每个 :ref:`MeshInstance3D` 可以共享绑定，这在从 Blender 导出的模型中很常见；或者每个 :ref:`MeshInstance3D` 可以使用单独的 :ref:`Skin` 对象，这在从其他工具（例如 Maya）导出的模型中很常见。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimportershaderfile.rst b/classes/zh_CN/class_resourceimportershaderfile.rst index 91d4d8d654..eb6fe2e726 100644 --- a/classes/zh_CN/class_resourceimportershaderfile.rst +++ b/classes/zh_CN/class_resourceimportershaderfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterShaderFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterShaderFile.xml. .. _class_ResourceImporterShaderFile: @@ -22,6 +22,7 @@ ResourceImporterShaderFile 这会将原生 GLSL 着色器导入为 :ref:`RDShaderFile` 资源，以与低级 :ref:`RenderingDevice` 操作一起使用。该导入器\ *不*\ 处理 ``.gdshader`` 文件。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimportersvg.rst b/classes/zh_CN/class_resourceimportersvg.rst new file mode 100644 index 0000000000..7fae97d383 --- /dev/null +++ b/classes/zh_CN/class_resourceimportersvg.rst @@ -0,0 +1,103 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterSVG.xml. + +.. _class_ResourceImporterSVG: + +ResourceImporterSVG +=================== + +**继承：** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +Imports an SVG file as an automatically scalable texture for use in UI elements and 2D rendering. + +.. rst-class:: classref-introduction-group + +描述 +---- + +This importer imports :ref:`DPITexture` resources. See also :ref:`ResourceImporterTexture` and :ref:`ResourceImporterImage`. + +.. rst-class:: classref-reftable-group + +属性 +---- + +.. table:: + :widths: auto + + +-------------------------------------+------------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`base_scale` | ``1.0`` | + +-------------------------------------+------------------------------------------------------------------+----------+ + | :ref:`Dictionary` | :ref:`color_map` | ``{}`` | + +-------------------------------------+------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +-------------------------------------+------------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`saturation` | ``1.0`` | + +-------------------------------------+------------------------------------------------------------------+----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +属性说明 +-------- + +.. _class_ResourceImporterSVG_property_base_scale: + +.. rst-class:: classref-property + +:ref:`float` **base_scale** = ``1.0`` :ref:`🔗` + +Texture scale. ``1.0`` is the original SVG size. Higher values result in a larger image. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterSVG_property_color_map: + +.. rst-class:: classref-property + +:ref:`Dictionary` **color_map** = ``{}`` :ref:`🔗` + +If set, remaps texture colors according to :ref:`Color`-:ref:`Color` map. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterSVG_property_compress: + +.. rst-class:: classref-property + +:ref:`bool` **compress** = ``true`` :ref:`🔗` + +如果为 ``true``\ ，则对 SVG 源码使用无损压缩。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterSVG_property_saturation: + +.. rst-class:: classref-property + +:ref:`float` **saturation** = ``1.0`` :ref:`🔗` + +覆盖纹理饱和度。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_resourceimportertexture.rst b/classes/zh_CN/class_resourceimportertexture.rst index b31ec42989..1fbc944ec8 100644 --- a/classes/zh_CN/class_resourceimportertexture.rst +++ b/classes/zh_CN/class_resourceimportertexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTexture.xml. .. _class_ResourceImporterTexture: @@ -49,6 +49,10 @@ ResourceImporterTexture +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`compress/normal_map` | ``0`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/rdo_quality_loss` | ``0.0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/uastc_level` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`detect_3d/compress_to` | ``1`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`editor/convert_colors_with_editor_theme` | ``false`` | @@ -59,6 +63,14 @@ ResourceImporterTexture +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process/channel_remap/alpha` | ``3`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process/channel_remap/blue` | ``2`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process/channel_remap/green` | ``1`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process/channel_remap/red` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`process/fix_alpha_border` | ``true`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`process/hdr_as_srgb` | ``false`` | @@ -189,6 +201,34 @@ BPTC 和 ASTC 支持 HDR 纹理的 VRAM 压缩，但 S3TC 和 ETC2 不支持（ ---- +.. _class_ResourceImporterTexture_property_compress/rdo_quality_loss: + +.. rst-class:: classref-property + +:ref:`float` **compress/rdo_quality_loss** = ``0.0`` :ref:`🔗` + +如果大于等于 ``0.01``\ ，则会启用率-失真优化（Rate-Distortion Optimization、RDO）来降低文件大小。值越高文件大小越小，但质量也越低。 + +\ **注意：**\ 启用 RDO 会显著增加编码时间，在图像较大时尤为明显。 + +如果想要进一步降低文件大小，请参阅 :ref:`ProjectSettings.rendering/textures/basis_universal/rdo_dict_size` 和 :ref:`ProjectSettings.rendering/textures/basis_universal/zstd_supercompression_level`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/uastc_level: + +.. rst-class:: classref-property + +:ref:`int` **compress/uastc_level** = ``0`` :ref:`🔗` + +UASTC 编码级别。值越高质量越好，但编码耗时更长。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterTexture_property_detect_3d/compress_to: .. rst-class:: classref-property @@ -263,6 +303,142 @@ BPTC 和 ASTC 支持 HDR 纹理的 VRAM 压缩，但 S3TC 和 ETC2 不支持（ ---- +.. _class_ResourceImporterTexture_property_process/channel_remap/alpha: + +.. rst-class:: classref-property + +:ref:`int` **process/channel_remap/alpha** = ``3`` :ref:`🔗` + +指定输出图像 Alpha 通道的数据源。 + +\ **Red：**\ 使用源图像中红色通道的值。 + +\ **Green：**\ 使用源图像中绿色通道的值。 + +\ **Blue：**\ 使用源图像中蓝色通道的值。 + +\ **Alpha：**\ 使用源图像中 Alpha 通道的值。 + +\ **Red Inverted：**\ 使用源图像中红色通道反转后的值（\ ``1.0 - R``\ ）。 + +\ **Green Inverted：**\ 使用源图像中绿色通道反转后的值（\ ``1.0 - G``\ ）。 + +\ **Blue Inverted：**\ 使用源图像中蓝色通道反转后的值（\ ``1.0 - B``\ ）。 + +\ **Alpha Inverted：**\ 使用源图像中 Alpha 通道反转后的值（\ ``1.0 - A``\ ）。 + +\ **Unused：**\ 将颜色通道的值设为默认值（Alpha 通道为 ``1.0``\ ，红绿蓝通道为 ``0.0``\ ）。 + +\ **Zero：**\ 将颜色通道的值设为 ``0.0``\ 。 + +\ **One：**\ 将颜色通道的值设为 ``1.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/channel_remap/blue: + +.. rst-class:: classref-property + +:ref:`int` **process/channel_remap/blue** = ``2`` :ref:`🔗` + +指定输出图像蓝色通道的数据源。 + +\ **Red：**\ 使用源图像中红色通道的值。 + +\ **Green：**\ 使用源图像中绿色通道的值。 + +\ **Blue：**\ 使用源图像中蓝色通道的值。 + +\ **Alpha：**\ 使用源图像中 Alpha 通道的值。 + +\ **Red Inverted：**\ 使用源图像中红色通道反转后的值（\ ``1.0 - R``\ ）。 + +\ **Green Inverted：**\ 使用源图像中绿色通道反转后的值（\ ``1.0 - G``\ ）。 + +\ **Blue Inverted：**\ 使用源图像中蓝色通道反转后的值（\ ``1.0 - B``\ ）。 + +\ **Alpha Inverted：**\ 使用源图像中 Alpha 通道反转后的值（\ ``1.0 - A``\ ）。 + +\ **Unused：**\ 将颜色通道的值设为默认值（Alpha 通道为 ``1.0``\ ，红绿蓝通道为 ``0.0``\ ）。 + +\ **Zero：**\ 将颜色通道的值设为 ``0.0``\ 。 + +\ **One：**\ 将颜色通道的值设为 ``1.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/channel_remap/green: + +.. rst-class:: classref-property + +:ref:`int` **process/channel_remap/green** = ``1`` :ref:`🔗` + +指定输出图像绿色通道的数据源。 + +\ **Red：**\ 使用源图像中红色通道的值。 + +\ **Green：**\ 使用源图像中绿色通道的值。 + +\ **Blue：**\ 使用源图像中蓝色通道的值。 + +\ **Alpha：**\ 使用源图像中 Alpha 通道的值。 + +\ **Red Inverted：**\ 使用源图像中红色通道反转后的值（\ ``1.0 - R``\ ）。 + +\ **Green Inverted：**\ 使用源图像中绿色通道反转后的值（\ ``1.0 - G``\ ）。 + +\ **Blue Inverted：**\ 使用源图像中蓝色通道反转后的值（\ ``1.0 - B``\ ）。 + +\ **Alpha Inverted：**\ 使用源图像中 Alpha 通道反转后的值（\ ``1.0 - A``\ ）。 + +\ **Unused：**\ 将颜色通道的值设为默认值（Alpha 通道为 ``1.0``\ ，红绿蓝通道为 ``0.0``\ ）。 + +\ **Zero：**\ 将颜色通道的值设为 ``0.0``\ 。 + +\ **One：**\ 将颜色通道的值设为 ``1.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/channel_remap/red: + +.. rst-class:: classref-property + +:ref:`int` **process/channel_remap/red** = ``0`` :ref:`🔗` + +指定输出图像红色通道的数据源。 + +\ **Red：**\ 使用源图像中红色通道的值。 + +\ **Green：**\ 使用源图像中绿色通道的值。 + +\ **Blue：**\ 使用源图像中蓝色通道的值。 + +\ **Alpha：**\ 使用源图像中 Alpha 通道的值。 + +\ **Red Inverted：**\ 使用源图像中红色通道反转后的值（\ ``1.0 - R``\ ）。 + +\ **Green Inverted：**\ 使用源图像中绿色通道反转后的值（\ ``1.0 - G``\ ）。 + +\ **Blue Inverted：**\ 使用源图像中蓝色通道反转后的值（\ ``1.0 - B``\ ）。 + +\ **Alpha Inverted：**\ 使用源图像中 Alpha 通道反转后的值（\ ``1.0 - A``\ ）。 + +\ **Unused：**\ 将颜色通道的值设为默认值（Alpha 通道为 ``1.0``\ ，红绿蓝通道为 ``0.0``\ ）。 + +\ **Zero：**\ 将颜色通道的值设为 ``0.0``\ 。 + +\ **One：**\ 将颜色通道的值设为 ``1.0``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterTexture_property_process/fix_alpha_border: .. rst-class:: classref-property @@ -313,6 +489,8 @@ BPTC 和 ASTC 支持 HDR 纹理的 VRAM 压缩，但 S3TC 和 ETC2 不支持（ :ref:`bool` **process/normal_map_invert_y** = ``false`` :ref:`🔗` +**已弃用：** The same result can be achieved by setting :ref:`process/channel_remap/green` to ``Green Inverted``. + 如果为 ``true``\ ，则通过反转其绿色通道将法线贴图从 Y-（DirectX 风格）转换为 Y+（OpenGL 风格）。这是 Godot 所期望的法线贴图约定。 有关法线贴图（包括流行引擎的坐标顺序表）的更多信息，可以在\ `这里 `__\ 找到。 @@ -396,6 +574,7 @@ SVG 应渲染的比例，\ ``1.0`` 是原始设计尺寸。值越高，图像越 \ **注意：**\ 仅适用于 SVG 图像。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimportertextureatlas.rst b/classes/zh_CN/class_resourceimportertextureatlas.rst index 739e450998..7229f1fb25 100644 --- a/classes/zh_CN/class_resourceimportertextureatlas.rst +++ b/classes/zh_CN/class_resourceimportertextureatlas.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterTextureAtlas.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTextureAtlas.xml. .. _class_ResourceImporterTextureAtlas: @@ -101,6 +101,7 @@ ResourceImporterTextureAtlas \ **注意：**\ 仅当 :ref:`import_mode` 为\ **区块**\ 时有效。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceimporterwav.rst b/classes/zh_CN/class_resourceimporterwav.rst index ed6be18da9..079fa7f864 100644 --- a/classes/zh_CN/class_resourceimporterwav.rst +++ b/classes/zh_CN/class_resourceimporterwav.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceImporterWAV.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterWAV.xml. .. _class_ResourceImporterWAV: @@ -208,6 +208,7 @@ WAV 是未经压缩的格式，能够提供比 Ogg Vorbis 和 MP3 更高的质 如果为 ``true``\ ，则会在源文件为立体声时，强制让导入的音频使用单声道。将两个声道合并能够将文件大小降低 50%。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceloader.rst b/classes/zh_CN/class_resourceloader.rst index bd038c4b1b..fb16fe6881 100644 --- a/classes/zh_CN/class_resourceloader.rst +++ b/classes/zh_CN/class_resourceloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceLoader.xml. .. _class_ResourceLoader: @@ -228,15 +228,18 @@ enum **CacheMode**: :ref:`🔗` :ref:`PackedStringArray` **get_dependencies**\ (\ path\: :ref:`String`\ ) :ref:`🔗` -返回位于给定路径 ``path`` 的资源的依赖项。 +返回路径为 ``path`` 的资源的依赖项。 -\ **注意：**\ 返回的单个依赖项是由 ``::`` 分隔的切片。你可以使用 :ref:`String.get_slice()` 来获取每段的内容。 +每个依赖项都是一个字符串，可以用 ``::`` 分割为若干部分。分割后只会有一个部分或三个部分，其中第二个部分始终为空。如果只有一个部分，则包含的是文件路径。如果有三个部分，则第一个部分包含的是 UID、第三个部分包含的是回退路径。 :: for dependency in ResourceLoader.get_dependencies(path): - print(dependency.get_slice("::", 0)) # 输出 UID。 - print(dependency.get_slice("::", 2)) # 输出路径。 + if dependency.contains("::"): + print(dependency.get_slice("::", 0)) # 输出 UID。 + print(dependency.get_slice("::", 2)) # 输出回退路径。 + else: + print(dependency) # 输出路径。 .. rst-class:: classref-item-separator @@ -286,7 +289,16 @@ enum **CacheMode**: :ref:`🔗` :ref:`PackedStringArray` **list_directory**\ (\ directory_path\: :ref:`String`\ ) :ref:`🔗` -列出目录（例如“res://assets/enemies”），返回目录中包含的所有资源。资源文件为原始文件名，与导出前编辑器中所显示的名称一致。 +列出目录，返回其中包含的所有资源和子目录。资源文件使用原始文件名，与导出前编辑器中看到的一致。目录末尾有 ``"/"``\ 。 + +:: + + # 输出 ["extra_data/", "model.gltf", "model.tscn", "model_slime.png"] + print(ResourceLoader.list_directory("res://assets/enemies/slime")) + +\ **注意：**\ 该方法返回的文件和目录的顺序并不固定，不同操作系统返回的顺序可能不同。 + +\ **注意：**\ 正常遍历文件系统请使用 :ref:`DirAccess`. .. rst-class:: classref-item-separator @@ -304,7 +316,7 @@ enum **CacheMode**: :ref:`🔗` 可选的 ``type_hint`` 可用于进一步指定 :ref:`ResourceFormatLoader` 应处理的 :ref:`Resource` 类型。任何继承自 :ref:`Resource` 的东西都可以用作类型提示，例如 :ref:`Image`\ 。 -\ ``cache_mode`` 属性定义在加载资源时是否以及如何使用或更新缓存。详见 :ref:`CacheMode`\ 。 +\ ``cache_mode`` 属性定义在加载资源时是否以及如何使用或更新缓存。 如果没有 :ref:`ResourceFormatLoader` 可以处理该文件则返回空资源，如果指定路径的文件未找到则会输出错误。 @@ -338,7 +350,7 @@ GDScript 具有一个简化的 :ref:`@GDScript.load()` **load_threaded_get_status**\ (\ path\: :ref:`String`, progress\: :ref:`Array` = []\ ) :ref:`🔗` -返回使用 :ref:`load_threaded_request()` 在 ``path`` 处启动的线程加载操作的状态。可能的返回值见 :ref:`ThreadLoadStatus`\ 。 +返回使用 :ref:`load_threaded_request()` 在 ``path`` 处启动的线程加载操作的状态。 还可以通过 ``progress`` 传递数组变量，会返回一个包含线程加载完成比例的单元素的数组（在 ``0.0`` 和 ``1.0`` 之间）。 @@ -356,7 +368,7 @@ GDScript 具有一个简化的 :ref:`@GDScript.load()`\ 。 +\ ``cache_mode`` 属性定义在加载资源时是否以及如何使用或更新缓存。 .. rst-class:: classref-item-separator @@ -383,6 +395,7 @@ GDScript 具有一个简化的 :ref:`@GDScript.load()` | :ref:`save`\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_uid`\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -189,13 +191,28 @@ flags **SaverFlags**: :ref:`🔗` 使用识别资源对象的 :ref:`ResourceFormatSaver` 将资源保存到给定路径。如果 ``path`` 为空，则 **ResourceSaver** 将尝试使用 :ref:`Resource.resource_path`\ 。 -可以指定 ``flags`` 位掩码以使用 :ref:`SaverFlags` 标志自定义保存行为。 +可以指定 ``flags`` 位掩码自定义保存行为。 成功时返回 :ref:`@GlobalScope.OK`\ 。 \ **注意：**\ 项目正运行时，任何生成的与资源关联的 UID 都不会被保存，因为所需的代码仅在编辑器模式下执行。 +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceSaver_method_set_uid: + +.. rst-class:: classref-method + +:ref:`Error` **set_uid**\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) :ref:`🔗` + +将 ``resource`` 资源的路径 UID 设置为 ``uid``\ 。你可以使用 :ref:`ResourceUID.create_id()` 来生成新的 UID。 + +由于资源一般会自动获取 UID，该方法仅适用于非常特别的场合。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_resourceuid.rst b/classes/zh_CN/class_resourceuid.rst index 1824423f70..1d11d4cfbd 100644 --- a/classes/zh_CN/class_resourceuid.rst +++ b/classes/zh_CN/class_resourceuid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ResourceUID.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceUID.xml. .. _class_ResourceUID: @@ -36,18 +36,26 @@ ResourceUID +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_id`\ (\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_id_for_path`\ (\ path\: :ref:`String`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ensure_path`\ (\ path_or_uid\: :ref:`String`\ ) |static| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_id_path`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_id`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`id_to_text`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`path_to_uid`\ (\ path\: :ref:`String`\ ) |static| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_id`\ (\ id\: :ref:`int`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_id`\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_to_id`\ (\ text_id\: :ref:`String`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uid_to_path`\ (\ uid\: :ref:`String`\ ) |static| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -105,6 +113,30 @@ ResourceUID ---- +.. _class_ResourceUID_method_create_id_for_path: + +.. rst-class:: classref-method + +:ref:`int` **create_id_for_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +与 :ref:`create_id()` 类型，但是 UID 会使用 ``path`` 路径和项目名称设置随机数种子。在当前项目中为该路径生成的 UID 始终相同。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceUID_method_ensure_path: + +.. rst-class:: classref-method + +:ref:`String` **ensure_path**\ (\ path_or_uid\: :ref:`String`\ ) |static| :ref:`🔗` + +返回路径，必要时会对 ``path_or_uid`` 进行转换。如果提供的是无效 UID 则会打印错误。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceUID_method_get_id_path: .. rst-class:: classref-method @@ -143,6 +175,18 @@ ResourceUID ---- +.. _class_ResourceUID_method_path_to_uid: + +.. rst-class:: classref-method + +:ref:`String` **path_to_uid**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` + +将 ``path`` 中提供的资源路径转换为 UID。如果没有与之关联的 UID 则会原样返回该路径。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceUID_method_remove_id: .. rst-class:: classref-method @@ -179,7 +223,20 @@ ResourceUID 从给定的 ``uid://`` 字符串中提取 UID 值。 +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceUID_method_uid_to_path: + +.. rst-class:: classref-method + +:ref:`String` **uid_to_path**\ (\ uid\: :ref:`String`\ ) |static| :ref:`🔗` + +将 ``uid`` 转换为路径。如果该 UID 无效则打印错误。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_retargetmodifier3d.rst b/classes/zh_CN/class_retargetmodifier3d.rst index ee8410dac8..19b1f923f5 100644 --- a/classes/zh_CN/class_retargetmodifier3d.rst +++ b/classes/zh_CN/class_retargetmodifier3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RetargetModifier3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RetargetModifier3D.xml. .. _class_RetargetModifier3D: @@ -252,6 +252,7 @@ flags **TransformFlag**: :ref:`🔗` 在 :ref:`enable` 中设置 :ref:`TRANSFORM_FLAG_SCALE`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_ribbontrailmesh.rst b/classes/zh_CN/class_ribbontrailmesh.rst index ae5f34f350..230839f17a 100644 --- a/classes/zh_CN/class_ribbontrailmesh.rst +++ b/classes/zh_CN/class_ribbontrailmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RibbonTrailMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RibbonTrailMesh.xml. .. _class_RibbonTrailMesh: @@ -193,6 +193,7 @@ enum **Shape**: :ref:`🔗` 条带的基础大小。通过将这个大小乘以 :ref:`curve` 上给定位置对应的值，就可以得到分节上某一段的大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_richtexteffect.rst b/classes/zh_CN/class_richtexteffect.rst index 26a3fb7c17..0cab79cc66 100644 --- a/classes/zh_CN/class_richtexteffect.rst +++ b/classes/zh_CN/class_richtexteffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RichTextEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RichTextEffect.xml. .. _class_RichTextEffect: @@ -79,6 +79,7 @@ RichTextEffect 覆盖该方法以修改 ``char_fx`` 中的属性。如果字符可以被成功转换，则该方法必须返回 ``true``\ 。如果该方法返回 ``false``\ ，则它将跳过转换以避免显示损坏的文本。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_richtextlabel.rst b/classes/zh_CN/class_richtextlabel.rst index 8ef8f4fc17..e69691d7ba 100644 --- a/classes/zh_CN/class_richtextlabel.rst +++ b/classes/zh_CN/class_richtextlabel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RichTextLabel.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RichTextLabel.xml. .. _class_RichTextLabel: @@ -29,7 +29,7 @@ RichTextLabel \ **注意：**\ ``push_*/pop`` 函数不会影响 BBCode。 -\ **注意：**\ 与 :ref:`Label` 不同，\ **RichTextLabel** 没有使文本水平居中的\ *属性*\ 。请启用 :ref:`bbcode_enabled` 并将文本包围在 ``[center]`` 标签中，类似：\ ``[center]示例[/center]``\ 。目前也没有垂直对齐文本的内置方法，但这可以通过使用锚点/容器和 :ref:`fit_content` 属性来模拟。 +\ **注意：**\ 当 :ref:`bbcode_enabled` 处于启用状态时，\ ``[center]`` 等对齐标签的优先级比 :ref:`horizontal_alignment` 设置要高，后者设置的是默认文本对齐。 .. rst-class:: classref-introduction-group @@ -53,6 +53,8 @@ RichTextLabel +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``3`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`bbcode_enabled` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | @@ -67,6 +69,8 @@ RichTextLabel +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`fit_content` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`hint_underlined` | ``true`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``0`` | @@ -83,6 +87,8 @@ RichTextLabel +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`scroll_following` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_following_visible_characters` | ``false`` | + +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`selection_enabled` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_keys_enabled` | ``true`` | @@ -118,151 +124,163 @@ RichTextLabel .. table:: :widths: auto - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_image`\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_text`\ (\ text\: :ref:`String`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_text`\ (\ bbcode\: :ref:`String`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_line`\ (\ character\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_paragraph`\ (\ character\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_height`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_width`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_offset`\ (\ line\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_paragraph_count`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_paragraph_offset`\ (\ paragraph\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_parsed_text`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_selection_line_offset`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_character_count`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_paragraph_count`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`install_effect`\ (\ effect\: :ref:`Variant`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`invalidate_paragraph`\ (\ paragraph\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finished`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_ready`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`newline`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`parse_bbcode`\ (\ bbcode\: :ref:`String`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`parse_expressions_for_values`\ (\ expressions\: :ref:`PackedStringArray`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`pop`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`pop_all`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`pop_context`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_bgcolor`\ (\ bgcolor\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_bold`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_bold_italics`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_cell`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_color`\ (\ color\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_context`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_customfx`\ (\ effect\: :ref:`RichTextEffect`, env\: :ref:`Dictionary`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_dropcap`\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_fgcolor`\ (\ fgcolor\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_font`\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_font_size`\ (\ font_size\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_hint`\ (\ description\: :ref:`String`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_indent`\ (\ level\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_italics`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_language`\ (\ language\: :ref:`String`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_list`\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_meta`\ (\ data\: :ref:`Variant`, underline_mode\: :ref:`MetaUnderline` = 1, tooltip\: :ref:`String` = ""\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_mono`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_normal`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_outline_color`\ (\ color\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_outline_size`\ (\ outline_size\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_paragraph`\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_strikethrough`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_table`\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_underline`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`scroll_to_line`\ (\ line\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`scroll_to_paragraph`\ (\ paragraph\: :ref:`int`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`scroll_to_selection`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select_all`\ (\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_border_color`\ (\ color\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_padding`\ (\ padding\: :ref:`Rect2`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_row_background_color`\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_size_override`\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_table_column_expand`\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1, shrink\: :ref:`bool` = true\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`update_image`\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_hr`\ (\ width\: :ref:`int` = 90, height\: :ref:`int` = 2, color\: :ref:`Color` = Color(1, 1, 1, 1), alignment\: :ref:`HorizontalAlignment` = 1, width_in_percent\: :ref:`bool` = true, height_in_percent\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_image`\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", width_in_percent\: :ref:`bool` = false, height_in_percent\: :ref:`bool` = false, alt_text\: :ref:`String` = ""\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_text`\ (\ text\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_text`\ (\ bbcode\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_line`\ (\ character\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_paragraph`\ (\ character\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_height`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_width`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_height`\ (\ line\: :ref:`int`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_offset`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_paragraph_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_paragraph_offset`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_parsed_text`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_selection_line_offset`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_character_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_visible_content_rect`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_paragraph_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`install_effect`\ (\ effect\: :ref:`Variant`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`invalidate_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finished`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_ready`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`newline`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_bbcode`\ (\ bbcode\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`parse_expressions_for_values`\ (\ expressions\: :ref:`PackedStringArray`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop_all`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop_context`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bgcolor`\ (\ bgcolor\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bold`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bold_italics`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_cell`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_context`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_customfx`\ (\ effect\: :ref:`RichTextEffect`, env\: :ref:`Dictionary`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_dropcap`\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_fgcolor`\ (\ fgcolor\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_font`\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_font_size`\ (\ font_size\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_hint`\ (\ description\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_indent`\ (\ level\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_italics`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_language`\ (\ language\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_list`\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_meta`\ (\ data\: :ref:`Variant`, underline_mode\: :ref:`MetaUnderline` = 1, tooltip\: :ref:`String` = ""\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_mono`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_normal`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_outline_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_outline_size`\ (\ outline_size\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_paragraph`\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_strikethrough`\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_table`\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1, name\: :ref:`String` = ""\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_underline`\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reload_effects`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_line`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_selection`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_border_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_padding`\ (\ padding\: :ref:`Rect2`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_row_background_color`\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_size_override`\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_table_column_expand`\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1, shrink\: :ref:`bool` = true\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_table_column_name`\ (\ column\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_image`\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", width_in_percent\: :ref:`bool` = false, height_in_percent\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -272,65 +290,73 @@ RichTextLabel .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`default_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`font_selected_color` | ``Color(0, 0, 0, 0)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`font_shadow_color` | ``Color(0, 0, 0, 0)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`selection_color` | ``Color(0.1, 0.1, 1, 0.8)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`table_border` | ``Color(0, 0, 0, 0)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`table_even_row_bg` | ``Color(0, 0, 0, 0)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Color` | :ref:`table_odd_row_bg` | ``Color(0, 0, 0, 0)`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`line_separation` | ``0`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`shadow_offset_x` | ``1`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`shadow_offset_y` | ``1`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`shadow_outline_size` | ``1`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`table_h_separation` | ``3`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`table_v_separation` | ``3`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`text_highlight_h_padding` | ``3`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`text_highlight_v_padding` | ``3`` | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Font` | :ref:`bold_font` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Font` | :ref:`bold_italics_font` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Font` | :ref:`italics_font` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Font` | :ref:`mono_font` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`Font` | :ref:`normal_font` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`bold_font_size` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`bold_italics_font_size` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`italics_font_size` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`mono_font_size` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`int` | :ref:`normal_font_size` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +---------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`default_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`font_selected_color` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`font_shadow_color` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`selection_color` | ``Color(0.1, 0.1, 1, 0.8)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`table_border` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`table_even_row_bg` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Color` | :ref:`table_odd_row_bg` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`line_separation` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`paragraph_separation` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`shadow_offset_x` | ``1`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`shadow_offset_y` | ``1`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`shadow_outline_size` | ``1`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`strikethrough_alpha` | ``50`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`table_h_separation` | ``3`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`table_v_separation` | ``3`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`text_highlight_h_padding` | ``3`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`text_highlight_v_padding` | ``3`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`underline_alpha` | ``50`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Font` | :ref:`bold_font` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Font` | :ref:`bold_italics_font` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Font` | :ref:`italics_font` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Font` | :ref:`mono_font` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Font` | :ref:`normal_font` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`bold_font_size` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`bold_italics_font_size` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`italics_font_size` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`mono_font_size` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`int` | :ref:`normal_font_size` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`Texture2D` | :ref:`horizontal_rule` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ + | :ref:`StyleBox` | :ref:`normal` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------------+ .. rst-class:: classref-section-separator @@ -611,7 +637,24 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) - :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) -如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内换行。要了解每种模式的行为，请参见 :ref:`AutowrapMode`\ 。 +如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内换行。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_property_autowrap_trim_flags: + +.. rst-class:: classref-property + +|bitfield|\[:ref:`LineBreakFlag`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +自动换行空格修剪标志。详见 :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` 和 :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES`\ 。 .. rst-class:: classref-item-separator @@ -751,7 +794,7 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。请将其设置为 :ref:`HorizontalAlignment` 常量。 +控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充。 .. rst-class:: classref-item-separator @@ -768,7 +811,7 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) - |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) -行两端对齐规则。详见 :ref:`JustificationFlag`\ 。 +行填充对齐规则。 .. rst-class:: classref-item-separator @@ -861,6 +904,23 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_property_scroll_following_visible_characters: + +.. rst-class:: classref-property + +:ref:`bool` **scroll_following_visible_characters** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_scroll_follow_visible_characters**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_following_visible_characters**\ (\ ) + +如果为 ``true``\ ，则 :ref:`visible_characters` 或 :ref:`visible_ratio` 发生修改时窗口会滚动到能够显示最后一个可见行。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_property_selection_enabled: .. rst-class:: classref-property @@ -1029,7 +1089,7 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) - :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) -控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐和填充。将其设置为 :ref:`VerticalAlignment` 常量之一。 +控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐、填充。 .. rst-class:: classref-item-separator @@ -1046,9 +1106,11 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_visible_characters**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_visible_characters**\ (\ ) -要显示的字符数。如果设置为 ``-1``\ ，则显示所有字符。这用于在对话框中为显示的文本设置动画。 +The number of characters to display. If set to ``-1``, all characters are displayed. This can be useful when animating the text appearing in a dialog box. -\ **注意：**\ 设置该属性会相应地更新 :ref:`visible_ratio`\ 。 +\ **Note:** Setting this property updates :ref:`visible_ratio` accordingly. + +\ **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings. .. rst-class:: classref-item-separator @@ -1065,7 +1127,7 @@ flags **ImageUpdateMask**: :ref:`🔗` - |void| **set_visible_characters_behavior**\ (\ value\: :ref:`VisibleCharactersBehavior`\ ) - :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior**\ (\ ) -设置 :ref:`visible_characters` 或 :ref:`visible_ratio` 被设置时的裁剪行为。有关详细信息，请参阅 :ref:`VisibleCharactersBehavior`\ 。 +设置 :ref:`visible_characters` 或 :ref:`visible_ratio` 被设置时的裁剪行为。 .. rst-class:: classref-item-separator @@ -1095,11 +1157,27 @@ flags **ImageUpdateMask**: :ref:`🔗` 方法说明 -------- +.. _class_RichTextLabel_method_add_hr: + +.. rst-class:: classref-method + +|void| **add_hr**\ (\ width\: :ref:`int` = 90, height\: :ref:`int` = 2, color\: :ref:`Color` = Color(1, 1, 1, 1), alignment\: :ref:`HorizontalAlignment` = 1, width_in_percent\: :ref:`bool` = true, height_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` + +添加一条横线，用于分隔内容。 + +如果设置了 ``width_in_percent``\ ，则 ``width`` 的值为控件宽度的百分比，而不是像素。 + +如果设置了 ``height_in_percent``\ ，则 ``height`` 的值为控件高度的百分比，而不是像素。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_add_image: .. rst-class:: classref-method -|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` +|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", width_in_percent\: :ref:`bool` = false, height_in_percent\: :ref:`bool` = false, alt_text\: :ref:`String` = ""\ ) :ref:`🔗` 将图像的开始和结束标签添加到标签栈中，可选择提供 ``width`` 和 ``height`` 来调整图像大小，提供 ``color`` 来给图像混色， ``region`` 只使用图像的一部分。 @@ -1111,7 +1189,11 @@ flags **ImageUpdateMask**: :ref:`🔗` 如果设置了 ``pad``\ ，并且该图像小于 ``width`` 和 ``height`` 指定的大小，则添加图像填充以匹配大小而不是放大图像。 -如果设置了 ``size_in_percent``\ ，则 ``width`` 和 ``height`` 值是控件宽度的百分比而不是像素。 +如果设置了 ``width_in_percent``\ ，则 ``width`` 的值为控件宽度的百分比，而不是像素。 + +如果设置了 ``height_in_percent``\ ，则 ``height`` 的值为控件高度的百分比，而不是像素。 + +\ ``alt_text`` 会被用作辅助应用中对图像的描述。 .. rst-class:: classref-item-separator @@ -1205,7 +1287,9 @@ flags **ImageUpdateMask**: :ref:`🔗` 返回内容的高度。 -\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 +\ **注意：**\ 该方法始终返回完整的内容大小，不受 :ref:`visible_ratio` 和 :ref:`visible_characters` 的影响。获取可见内容的大小请使用 :ref:`get_visible_content_rect()`\ 。 + +\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 .. rst-class:: classref-item-separator @@ -1219,7 +1303,9 @@ flags **ImageUpdateMask**: :ref:`🔗` 返回内容的宽度。 -\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 +\ **注意：**\ 该方法始终返回完整的内容大小，不受 :ref:`visible_ratio` 和 :ref:`visible_characters` 的影响。获取可见内容的大小请使用 :ref:`get_visible_content_rect()`\ 。 + +\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 .. rst-class:: classref-item-separator @@ -1231,9 +1317,21 @@ flags **ImageUpdateMask**: :ref:`🔗` :ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` -返回文本中的总行数。自动换行的文本计为多行。 +返回文本中的总行数。自动换行的文本算作多行。 -\ **注意：**\ 如果将 :ref:`visible_characters_behavior` 设为 :ref:`TextServer.VC_CHARS_BEFORE_SHAPING`\ ，则只会计算可见的换行。 +\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_method_get_line_height: + +.. rst-class:: classref-method + +:ref:`int` **get_line_height**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于提供的索引处的行的高度。 \ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 @@ -1271,6 +1369,20 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_method_get_line_width: + +.. rst-class:: classref-method + +:ref:`int` **get_line_width**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于提供的索引处的行的宽度。 + +\ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_get_menu: .. rst-class:: classref-method @@ -1295,7 +1407,7 @@ flags **ImageUpdateMask**: :ref:`🔗` menu.add_item("制作文本副本", MENU_MAX + 1) # 连接回调。 menu.id_pressed.connect(_on_item_pressed) - + func _on_item_pressed(id): if id == MENU_MAX + 1: add_text("\n" + get_parsed_text()) @@ -1313,7 +1425,7 @@ flags **ImageUpdateMask**: :ref:`🔗` // 添加事件处理器。 menu.IdPressed += OnItemPressed; } - + public void OnItemPressed(int id) { if (id == TextEdit.MenuItems.Max + 1) @@ -1438,6 +1550,51 @@ flags **ImageUpdateMask**: :ref:`🔗` \ **警告：**\ 这是一个必需的内部节点，删除和释放它可能会导致崩溃。如果你希望隐藏它或其任何子项，请使用它们的 :ref:`CanvasItem.visible` 属性。 +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_method_get_visible_content_rect: + +.. rst-class:: classref-method + +:ref:`Rect2i` **get_visible_content_rect**\ (\ ) |const| :ref:`🔗` + +返回可见内容的包围矩形。 + +\ **注意：**\ 该方法只会在标签发生绘制后返回正确值。 + + +.. tabs:: + + .. code-tab:: gdscript + + extends RichTextLabel + + @export var background_panel: Panel + + func _ready(): + await draw + background_panel.position = get_visible_content_rect().position + background_panel.size = get_visible_content_rect().size + + .. code-tab:: csharp + + public partial class TestLabel : RichTextLabel + { + [Export] + public Panel BackgroundPanel { get; set; } + + public override async void _Ready() + { + await ToSignal(this, Control.SignalName.Draw); + BackgroundGPanel.Position = GetVisibleContentRect().Position; + BackgroundPanel.Size = GetVisibleContentRect().Size; + } + } + + + .. rst-class:: classref-item-separator ---- @@ -1450,6 +1607,8 @@ flags **ImageUpdateMask**: :ref:`🔗` 返回可见行数。 +\ **注意：**\ 该方法只会在标签发生绘制后返回正确值。 + \ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回的是文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 .. rst-class:: classref-item-separator @@ -1464,6 +1623,8 @@ flags **ImageUpdateMask**: :ref:`🔗` 返回可见段落的数量。认为段落可见的标准是至少有一行可见。 +\ **注意：**\ 该方法只会在标签发生绘制后返回正确值。 + \ **注意：**\ 如果启用了 :ref:`threaded`\ ，则该方法返回文档已加载部分的值。请使用 :ref:`is_finished()` 或 :ref:`finished` 来确定文档是否已完全加载。 .. rst-class:: classref-item-separator @@ -1485,9 +1646,9 @@ flags **ImageUpdateMask**: :ref:`🔗` # effect.gd class_name MyCustomEffect extends RichTextEffect - + var bbcode = "my_custom_effect" - + # ... 可以通过脚本在 **RichTextLabel** 中安装上述效果： @@ -1496,10 +1657,10 @@ flags **ImageUpdateMask**: :ref:`🔗` # rich_text_label.gd extends RichTextLabel - + func _ready(): install_effect(MyCustomEffect.new()) - + # 或者，如果在扩展 RichTextEffect 的脚本中不使用“class_name”： install_effect(preload("res://effect.gd").new()) @@ -1647,7 +1808,9 @@ flags **ImageUpdateMask**: :ref:`🔗` |void| **push_bgcolor**\ (\ bgcolor\: :ref:`Color`\ ) :ref:`🔗` -向标签栈中添加 ``[bgcolor]`` 标签。 +将 ``[bgcolor]`` 标签添加到标签栈。 + +\ **注意：**\ 背景色默认存在边距，由 :ref:`text_highlight_h_padding` 和 :ref:`text_highlight_v_padding` 控制。这可能会导致相邻行/列的背景颜色重叠高亮，因此如果你想避免这种情况，请考虑将这些主题项设置为 ``0``\ 。 .. rst-class:: classref-item-separator @@ -1743,7 +1906,9 @@ flags **ImageUpdateMask**: :ref:`🔗` |void| **push_fgcolor**\ (\ fgcolor\: :ref:`Color`\ ) :ref:`🔗` -向标签栈中添加 ``[fgcolor]`` 标签。 +将 ``[fgcolor]`` 标签添加到标签栈。 + +\ **注意：**\ 前景色默认存在边距，由 :ref:`text_highlight_h_padding` 和 :ref:`text_highlight_v_padding` 控制。这可能会导致相邻行/列的前景颜色重叠高亮，因此如果你想避免这种情况，请考虑将这些主题项设置为 ``0``\ 。 .. rst-class:: classref-item-separator @@ -1915,9 +2080,9 @@ flags **ImageUpdateMask**: :ref:`🔗` .. rst-class:: classref-method -|void| **push_strikethrough**\ (\ ) :ref:`🔗` +|void| **push_strikethrough**\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) :ref:`🔗` -向标签栈中添加 ``[s]`` 标签。 +添加一个 ``[s]`` 标签到标签栈。如果 ``color`` 的 Alpha 值为零，则会使用当前字体的颜色并将其 Alpha 值与 :ref:`strikethrough_alpha` 相乘。 .. rst-class:: classref-item-separator @@ -1927,9 +2092,9 @@ flags **ImageUpdateMask**: :ref:`🔗` .. rst-class:: classref-method -|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) :ref:`🔗` +|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1, name\: :ref:`String` = ""\ ) :ref:`🔗` -向标签栈添加 ``[table=columns,inline_align]`` 标签。使用 :ref:`set_table_column_expand()` 设置列扩展率。使用 :ref:`push_cell()` 添加单元格。 +向标签栈添加 ``[table=columns,inline_align]`` 标签。使用 :ref:`set_table_column_expand()` 设置列扩展率。使用 :ref:`push_cell()` 添加单元格。\ ``name`` 会用作辅助应用中的表格名。 .. rst-class:: classref-item-separator @@ -1939,9 +2104,21 @@ flags **ImageUpdateMask**: :ref:`🔗` .. rst-class:: classref-method -|void| **push_underline**\ (\ ) :ref:`🔗` +|void| **push_underline**\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) :ref:`🔗` -向标签栈中添加 ``[u]`` 标签。 +添加一个 ``[u]`` 标签到标签栈。如果 ``color`` 的 Alpha 值为零，则会使用当前字体的颜色并将其 Alpha 值与 :ref:`underline_alpha` 相乘。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_method_reload_effects: + +.. rst-class:: classref-method + +|void| **reload_effects**\ (\ ) :ref:`🔗` + +重新加载自定义效果。适用于手动修改 :ref:`custom_effects` 的场合。 .. rst-class:: classref-item-separator @@ -2077,11 +2254,23 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_method_set_table_column_name: + +.. rst-class:: classref-method + +|void| **set_table_column_name**\ (\ column\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` + +为辅助应用设置表格的列名。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_update_image: .. rst-class:: classref-method -|void| **update_image**\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` +|void| **update_image**\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", width_in_percent\: :ref:`bool` = false, height_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` 使用键 ``key`` 更新已有图像。仅更新 ``mask`` 位指定的属性。请参阅 :ref:`add_image()`\ 。 @@ -2216,6 +2405,18 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_theme_constant_paragraph_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **paragraph_separation** = ``0`` :ref:`🔗` + +行与行之间的额外纵向留白（单位为像素），留白会被添加到上一行之后。该值可以为负数。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_theme_constant_shadow_offset_x: .. rst-class:: classref-themeproperty @@ -2252,6 +2453,18 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_theme_constant_strikethrough_alpha: + +.. rst-class:: classref-themeproperty + +:ref:`int` **strikethrough_alpha** = ``50`` :ref:`🔗` + +设置默认的删除线颜色透明度（百分比）。如果删除线使用自定义颜色，则该主题项只会在自定义颜色的 Alpha 为 ``0.0``\ （完全透明）时使用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_theme_constant_table_h_separation: .. rst-class:: classref-themeproperty @@ -2282,7 +2495,7 @@ flags **ImageUpdateMask**: :ref:`🔗` :ref:`int` **text_highlight_h_padding** = ``3`` :ref:`🔗` -由 ``[fgcolor]`` 和 ``[bgcolor]`` 标记绘制的框周围的水平填充。这不会影响文本选择的外观。 +由 ``[fgcolor]`` 和 ``[bgcolor]`` 标记绘制的框周围的水平填充，不会影响文本选择的外观。要避免相邻的高亮发生覆盖，请将其设为 ``0``\ ，禁用边距。 .. rst-class:: classref-item-separator @@ -2294,7 +2507,19 @@ flags **ImageUpdateMask**: :ref:`🔗` :ref:`int` **text_highlight_v_padding** = ``3`` :ref:`🔗` -由 ``[fgcolor]`` 和 ``[bgcolor]`` 标记绘制的框周围的垂直填充。这不会影响文本选择的外观。 +由 ``[fgcolor]`` 和 ``[bgcolor]`` 标记绘制的框周围的垂直填充，不会影响文本选择的外观。要避免相邻的高亮发生覆盖，请将其设为 ``0``\ ，禁用边距。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_theme_constant_underline_alpha: + +.. rst-class:: classref-themeproperty + +:ref:`int` **underline_alpha** = ``50`` :ref:`🔗` + +设置默认的下划线颜色透明度（百分比）。如果下划线使用自定义颜色，则该主题项只会在自定义颜色的 Alpha 为 ``0.0``\ （完全透明）时使用。 .. rst-class:: classref-item-separator @@ -2420,6 +2645,18 @@ flags **ImageUpdateMask**: :ref:`🔗` ---- +.. _class_RichTextLabel_theme_icon_horizontal_rule: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **horizontal_rule** :ref:`🔗` + +横线纹理。 + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_theme_style_focus: .. rst-class:: classref-themeproperty @@ -2441,6 +2678,7 @@ flags **ImageUpdateMask**: :ref:`🔗` **RichTextLabel** 的正常背景。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rid.rst b/classes/zh_CN/class_rid.rst index d07b640149..0f1a0d907c 100644 --- a/classes/zh_CN/class_rid.rst +++ b/classes/zh_CN/class_rid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RID.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RID.xml. .. _class_RID: @@ -102,7 +102,7 @@ RID :ref:`Variant` 类型用于通过其唯一 ID 访问底层资 :ref:`RID` **RID**\ (\ from\: :ref:`RID`\ ) -构造给定 **RID** 的副本。 +构造给定 **RID** 的副本 **RID**\ 。 .. rst-class:: classref-section-separator @@ -211,6 +211,7 @@ RID :ref:`Variant` 类型用于通过其唯一 ID 访问底层资 如果该 **RID** 的 ID 大于等于右侧 ``right`` 的 ID，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rigidbody2d.rst b/classes/zh_CN/class_rigidbody2d.rst index b554786d5e..95de78699c 100644 --- a/classes/zh_CN/class_rigidbody2d.rst +++ b/classes/zh_CN/class_rigidbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RigidBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RigidBody2D.xml. .. _class_RigidBody2D: @@ -27,15 +27,21 @@ RigidBody2D 即使施加了力，刚体也会始终维持自身的形状和大小。适用于环境中可交互的对象，例如能够推倒的树木或者能够被推动的一堆箱子。 +如果你需要直接影响物体，请优先使用 :ref:`_integrate_forces()`\ ，能够直接访问物理状态。 + 如果你需要覆盖默认的物理行为，你可以编写自定义的力整合函数。见 :ref:`custom_integrator`\ 。 -\ **注意：**\ 频繁修改 **RigidBody2D** 的 2D 变换或 :ref:`linear_velocity` 可能导致无法预期的行为。如果你需要直接影响物理体，请优先使用 :ref:`_integrate_forces()`\ ，能够直接访问物理状态。 +\ **注意：**\ 频繁修改 **RigidBody2D** 的 2D 变换或 :ref:`linear_velocity` 可能导致无法预期的行为。这也会发生在 **RigidBody2D** 是不断移动的节点的子孙节点时，比如另一个 **RigidBody2D**\ ，因为祖先移动时会导致设置全局变换。 .. rst-class:: classref-introduction-group 教程 ---- +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - `2D 物理平台跳跃演示 `__ - `实例化演示 `__ @@ -375,7 +381,7 @@ enum **CCDMode**: :ref:`🔗` - |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_angular_damp_mode**\ (\ ) -定义如何应用 :ref:`angular_damp`\ 。可能的取值见 :ref:`DampMode`\ 。 +定义如何应用 :ref:`angular_damp`\ 。 .. rst-class:: classref-item-separator @@ -426,9 +432,9 @@ enum **CCDMode**: :ref:`🔗` - |void| **set_center_of_mass**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_center_of_mass**\ (\ ) -当 :ref:`center_of_mass_mode` 设置为 :ref:`CENTER_OF_MASS_MODE_CUSTOM` 时，物体的自定义质心相对于物体原点位置的位置。这是物体的平衡点，只有施加在质心内的力才会引起线性加速度。施加在质心之外的力会引起角加速度。 +The body's custom center of mass, relative to the body's origin position, when :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_CUSTOM`. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration. -当 :ref:`center_of_mass_mode` 设置为 :ref:`CENTER_OF_MASS_MODE_AUTO`\ （默认值）时，会自动计算质心。 +When :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_AUTO` (default value), the center of mass is automatically determined, but this does not update the value of :ref:`center_of_mass`. .. rst-class:: classref-item-separator @@ -445,7 +451,7 @@ enum **CCDMode**: :ref:`🔗` - |void| **set_center_of_mass_mode**\ (\ value\: :ref:`CenterOfMassMode`\ ) - :ref:`CenterOfMassMode` **get_center_of_mass_mode**\ (\ ) -定义设置物体质心的方式。可能的取值见 :ref:`CenterOfMassMode`\ 。 +定义设置物体质心的方式。 .. rst-class:: classref-item-separator @@ -521,7 +527,7 @@ enum **CCDMode**: :ref:`🔗` 连续碰撞检测模式。 -连续碰撞检测尝试预测一个移动的物体会在哪里碰撞，而不是移动它并在碰撞后纠正它的运动。连续碰撞检测速度较慢，但更精确，并且与快速移动的小物体发生碰撞时遗漏更少。可以使用光线投射和形状投射方法。有关详细信息，请参阅 :ref:`CCDMode`\ 。 +连续碰撞检测尝试预测一个移动的物体会在哪里碰撞，而不是移动它并在碰撞后纠正它的运动。连续碰撞检测速度较慢，但更精确，并且与快速移动的小物体发生碰撞时遗漏更少。可以使用光线投射和形状投射方法。 .. rst-class:: classref-item-separator @@ -578,9 +584,9 @@ enum **CCDMode**: :ref:`🔗` - |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) - :ref:`FreezeMode` **get_freeze_mode**\ (\ ) -该物体的冻结模式。可以设置该物体在启用 :ref:`freeze` 时的行为。可能的值见 :ref:`FreezeMode`\ 。 +物体的冻结模式。可以设置该物体在启用 :ref:`freeze` 时的行为。 -对于始终冻结的物体，请改用 :ref:`StaticBody3D` 或 :ref:`AnimatableBody3D`\ 。 +始终冻结的物体请改用 :ref:`StaticBody3D` 或 :ref:`AnimatableBody3D`\ 。 .. rst-class:: classref-item-separator @@ -626,19 +632,19 @@ enum **CCDMode**: :ref:`🔗` .. code-tab:: gdscript @onready var ball = $Ball - + func get_ball_inertia(): return 1.0 / PhysicsServer2D.body_get_direct_state(ball.get_rid()).inverse_inertia .. code-tab:: csharp private RigidBody2D _ball; - + public override void _Ready() { _ball = GetNode("Ball"); } - + private float GetBallInertia() { return 1.0f / PhysicsServer2D.BodyGetDirectState(_ball.GetRid()).InverseInertia; @@ -680,7 +686,7 @@ enum **CCDMode**: :ref:`🔗` - |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_linear_damp_mode**\ (\ ) -定义如何应用 :ref:`linear_damp`\ 。有关可能的值，请参阅 :ref:`DampMode`\ 。 +定义如何应用 :ref:`linear_damp`\ 。 .. rst-class:: classref-item-separator @@ -976,6 +982,7 @@ enum **CCDMode**: :ref:`🔗` 设置物体在给定轴上的速度。给定矢量轴上的速度将设置为给定向量长度。这对于跳跃行为很有用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rigidbody3d.rst b/classes/zh_CN/class_rigidbody3d.rst index 7e873c68b3..0afd16a5fe 100644 --- a/classes/zh_CN/class_rigidbody3d.rst +++ b/classes/zh_CN/class_rigidbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RigidBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RigidBody3D.xml. .. _class_RigidBody3D: @@ -27,9 +27,11 @@ RigidBody3D 即使施加了力，刚体也会始终维持自身的形状和大小。适用于环境中可交互的对象，例如能够推倒的树木或者能够被推动的一堆箱子。 +如果你需要直接影响物体，请优先使用 :ref:`_integrate_forces()`\ ，能够直接访问物理状态。 + 如果你需要覆盖默认的物理行为，你可以编写自定义的力整合函数。见 :ref:`custom_integrator`\ 。 -\ **注意：**\ 频繁修改 **RigidBody3D** 的 3D 变换或 :ref:`linear_velocity` 可能导致无法预期的行为。如果你需要直接影响物理体，请优先使用 :ref:`_integrate_forces()`\ ，能够直接访问物理状态。 +\ **注意：**\ 频繁修改 **RigidBody3D** 的 3D 变换或 :ref:`linear_velocity` 可能导致无法预期的行为。这也会发生在 **RigidBody3D** 是不断移动的节点的子孙节点时，比如另一个 **RigidBody3D**\ ，因为祖先移动时会导致设置全局变换。 .. rst-class:: classref-introduction-group @@ -38,6 +40,8 @@ RigidBody3D - :doc:`物理介绍 <../tutorials/physics/physics_introduction>` +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - `3D 货车镇演示 `__ - `3D 物理测试演示 `__ @@ -345,7 +349,7 @@ enum **DampMode**: :ref:`🔗` - |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_angular_damp_mode**\ (\ ) -定义如何应用 :ref:`angular_damp`\ 。可能的取值见 :ref:`DampMode`\ 。 +定义如何应用 :ref:`angular_damp`\ 。 .. rst-class:: classref-item-separator @@ -396,9 +400,9 @@ enum **DampMode**: :ref:`🔗` - |void| **set_center_of_mass**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_center_of_mass**\ (\ ) -当 :ref:`center_of_mass_mode` 设置为 :ref:`CENTER_OF_MASS_MODE_CUSTOM` 时，物体的自定义质心相对于物体原点位置的位置。这是物体的平衡点，只有施加在质心内的力才会引起线性加速度。施加在质心之外的力会引起角加速度。 +The body's custom center of mass, relative to the body's origin position, when :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_CUSTOM`. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration. -当 :ref:`center_of_mass_mode` 设置为 :ref:`CENTER_OF_MASS_MODE_AUTO`\ （默认值）时，会自动计算质心。 +When :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_AUTO` (default value), the center of mass is automatically determined, but this does not update the value of :ref:`center_of_mass`. .. rst-class:: classref-item-separator @@ -415,7 +419,7 @@ enum **DampMode**: :ref:`🔗` - |void| **set_center_of_mass_mode**\ (\ value\: :ref:`CenterOfMassMode`\ ) - :ref:`CenterOfMassMode` **get_center_of_mass_mode**\ (\ ) -定义设置物体质心的方式。可能的取值见 :ref:`CenterOfMassMode`\ 。 +定义设置物体质心的方式。 .. rst-class:: classref-item-separator @@ -548,9 +552,9 @@ enum **DampMode**: :ref:`🔗` - |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) - :ref:`FreezeMode` **get_freeze_mode**\ (\ ) -物体的冻结模式。可用于设置启用 :ref:`freeze` 时物体的行为。可能的取值见 :ref:`FreezeMode` 。 +物体的冻结模式。可用于设置启用 :ref:`freeze` 时物体的行为。 -对于始终冻结的物体，请使用 :ref:`StaticBody3D` 或 :ref:`AnimatableBody3D`\ 。 +始终冻结的物体请使用 :ref:`StaticBody3D` 或 :ref:`AnimatableBody3D`\ 。 .. rst-class:: classref-item-separator @@ -596,19 +600,19 @@ enum **DampMode**: :ref:`🔗` .. code-tab:: gdscript @onready var ball = $Ball - + func get_ball_inertia(): return PhysicsServer3D.body_get_direct_state(ball.get_rid()).inverse_inertia.inverse() .. code-tab:: csharp private RigidBody3D _ball; - + public override void _Ready() { _ball = GetNode("Ball"); } - + private Vector3 GetBallInertia() { return PhysicsServer3D.BodyGetDirectState(_ball.GetRid()).InverseInertia.Inverse(); @@ -650,7 +654,7 @@ enum **DampMode**: :ref:`🔗` - |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) - :ref:`DampMode` **get_linear_damp_mode**\ (\ ) -定义如何应用 :ref:`linear_damp`\ 。有关可能的值，请参阅 :ref:`DampMode`\ 。 +定义如何应用 :ref:`linear_damp`\ 。 .. rst-class:: classref-item-separator @@ -958,6 +962,7 @@ enum **DampMode**: :ref:`🔗` 设置轴速度。给定向量轴上的速度将被设置为给定向量长度。这对跳跃行为很有用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_rootmotionview.rst b/classes/zh_CN/class_rootmotionview.rst index 968a85fbae..8922d06ada 100644 --- a/classes/zh_CN/class_rootmotionview.rst +++ b/classes/zh_CN/class_rootmotionview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/RootMotionView.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RootMotionView.xml. .. _class_RootMotionView: @@ -141,6 +141,7 @@ RootMotionView 如果为 ``true``\ ，则网格的点都将位于相同的 Y 坐标上（\ *local* Y = 0）。如果 ``false``\ ，则保留点的原始 Y 坐标。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scenemultiplayer.rst b/classes/zh_CN/class_scenemultiplayer.rst index 236e1efa00..62502f55e5 100644 --- a/classes/zh_CN/class_scenemultiplayer.rst +++ b/classes/zh_CN/class_scenemultiplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/multiplayer/doc_classes/SceneMultiplayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/SceneMultiplayer.xml. .. _class_SceneMultiplayer: @@ -347,6 +347,7 @@ SceneMultiplayer 向由 ``id`` 标识的特定对等体发送给定的原始字节 ``bytes``\ （见 :ref:`MultiplayerPeer.set_target_peer()`\ ）。默认 ID 为 ``0``\ ，即广播到所有对等体。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scenereplicationconfig.rst b/classes/zh_CN/class_scenereplicationconfig.rst index 60ed21736d..f111820360 100644 --- a/classes/zh_CN/class_scenereplicationconfig.rst +++ b/classes/zh_CN/class_scenereplicationconfig.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/multiplayer/doc_classes/SceneReplicationConfig.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/SceneReplicationConfig.xml. .. _class_SceneReplicationConfig: @@ -154,7 +154,7 @@ enum **ReplicationMode**: :ref:`🔗` **property_get_replication_mode**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` -返回给定 ``path`` 标识的属性的复制模式。请参阅 :ref:`ReplicationMode`\ 。 +返回给定 ``path`` 标识的属性的复制模式。 .. rst-class:: classref-item-separator @@ -206,7 +206,7 @@ enum **ReplicationMode**: :ref:`🔗`, mode\: :ref:`ReplicationMode`\ ) :ref:`🔗` -为路径为 ``path`` 的属性设置同步模式。见 :ref:`ReplicationMode`\ 。 +为路径为 ``path`` 的属性设置同步模式。 .. rst-class:: classref-item-separator @@ -261,6 +261,7 @@ enum **ReplicationMode**: :ref:`🔗` | :ref:`get_base_scene_state`\ (\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connection_binds`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,6 +74,8 @@ SceneState +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_node_type`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_path`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_instance_placeholder`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -137,6 +141,18 @@ enum **GenEditState**: :ref:`🔗` 方法说明 -------- +.. _class_SceneState_method_get_base_scene_state: + +.. rst-class:: classref-method + +:ref:`SceneState` **get_base_scene_state**\ (\ ) |const| :ref:`🔗` + +返回该场景所继承场景的 **SceneState**\ ，如果未继承任何场景则返回 ``null``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneState_method_get_connection_binds: .. rst-class:: classref-method @@ -385,6 +401,18 @@ enum **GenEditState**: :ref:`🔗` ---- +.. _class_SceneState_method_get_path: + +.. rst-class:: classref-method + +:ref:`String` **get_path**\ (\ ) |const| :ref:`🔗` + +返回代表的 :ref:`PackedScene` 的资源路径。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneState_method_is_node_instance_placeholder: .. rst-class:: classref-method @@ -394,6 +422,7 @@ enum **GenEditState**: :ref:`🔗` 如果 ``idx`` 处的节点是一个 :ref:`InstancePlaceholder`\ ，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scenetree.rst b/classes/zh_CN/class_scenetree.rst index 70cf06c306..efc70d70f8 100644 --- a/classes/zh_CN/class_scenetree.rst +++ b/classes/zh_CN/class_scenetree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SceneTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SceneTree.xml. .. _class_SceneTree: @@ -103,6 +103,10 @@ SceneTree +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_group`\ (\ name\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_accessibility_enabled`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_accessibility_supported`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_group`\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) | +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_group_flags`\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) | @@ -203,6 +207,25 @@ SceneTree ---- +.. _class_SceneTree_signal_scene_changed: + +.. rst-class:: classref-signal + +**scene_changed**\ (\ ) :ref:`🔗` + +新场景添加到场景树中并完成初始化后发出。切换场景时可以用这个信号来稳定地访问 :ref:`current_scene`\ 。 + +:: + + # 这段代码应当写在自动加载里。 + get_tree().change_scene_to_file(other_scene_path) + await get_tree().scene_changed + print(get_tree().current_scene) # 输出新场景。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneTree_signal_tree_changed: .. rst-class:: classref-signal @@ -446,10 +469,12 @@ enum **GroupCallFlags**: :ref:`🔗` - |void| **set_physics_interpolation_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_physics_interpolation_enabled**\ (\ ) -如果为 ``true``\ ，则渲染器将在最后两个变换之间插入物理对象的变换，这样即使物理刻度与渲染帧不一致，也能看到平滑的运动。 +如果为 ``true``\ ，则渲染器将在最后两个变换之间插入对象的变换（无论该对象为物理对象还是非物理对象），这样即使物理刻度与渲染帧不一致，也能看到平滑的运动。 该属性的默认值由 :ref:`ProjectSettings.physics/common/physics_interpolation` 控制。 +\ **注意：**\ 尽管这是全局设置，仍可使用 :ref:`Node.physics_interpolation_mode` 对 **SceneTree** 中的分支进行精细的控制。 + .. rst-class:: classref-item-separator ---- @@ -567,6 +592,8 @@ enum **GroupCallFlags**: :ref:`🔗` 这确保了两个场景不会同时运行，并且仍然会以类似于 :ref:`Node.queue_free()` 的安全方式释放之前的场景。 +如果你想要稳定地访问新场景，请等待 :ref:`scene_changed` 信号。 + .. rst-class:: classref-item-separator ---- @@ -646,7 +673,7 @@ enum **GroupCallFlags**: :ref:`🔗` :ref:`int` **get_frame**\ (\ ) |const| :ref:`🔗` -返回程序开始运行之后已经处理了多少帧。测量的\ *不是*\ 经过的时间。 +返回程序开始运行之后已经处理了多少个物理处理步骤。测量的\ *不是*\ 经过的时间。另见 :ref:`physics_frame`\ 。已渲染的帧数见 :ref:`Engine.get_process_frames()`\ 。 .. rst-class:: classref-item-separator @@ -724,6 +751,30 @@ enum **GroupCallFlags**: :ref:`🔗` ---- +.. _class_SceneTree_method_is_accessibility_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_accessibility_enabled**\ (\ ) |const| :ref:`🔗` + +如果启用了无障碍特性则返回 ``true``\ ，此时会主动处理无障碍信息的更新。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SceneTree_method_is_accessibility_supported: + +.. rst-class:: classref-method + +:ref:`bool` **is_accessibility_supported**\ (\ ) |const| :ref:`🔗` + +如果操作系统支持无障碍特性且在项目设置中进行了启用，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneTree_method_notify_group: .. rst-class:: classref-method @@ -832,6 +883,8 @@ enum **GroupCallFlags**: :ref:`🔗` \ **注意：**\ :ref:`MultiplayerAPI` 不能为包含 ``root_path`` 的子路径配置，嵌套的自定义多人游戏是不被允许的。例如，如果为 ``"/root/Foo"`` 配置了一项，则为 ``"/root/Foo/Bar"`` 设置一项将导致错误。 +\ **注意：**\ :ref:`set_multiplayer()` 应该在根路径 ``root_path`` 下的子节点就绪\ *之前*\ 调用。如果在自定义多人 API 设置之前将 :ref:`MultiplayerSpawner`\ 、\ :ref:`MultiplayerSynchronizer` 这样的多人节点添加到树中，这些节点将无法正常工作。 + .. rst-class:: classref-item-separator ---- @@ -845,6 +898,7 @@ enum **GroupCallFlags**: :ref:`🔗` 如果当前场景已加载，调用此方法将进行卸载。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scenetreetimer.rst b/classes/zh_CN/class_scenetreetimer.rst index 2a11c2ff1b..14efaf8029 100644 --- a/classes/zh_CN/class_scenetreetimer.rst +++ b/classes/zh_CN/class_scenetreetimer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SceneTreeTimer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SceneTreeTimer.xml. .. _class_SceneTreeTimer: @@ -100,6 +100,7 @@ SceneTreeTimer 剩余时间（单位为秒）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_script.rst b/classes/zh_CN/class_script.rst index c45b09799d..842ca7e988 100644 --- a/classes/zh_CN/class_script.rst +++ b/classes/zh_CN/class_script.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Script.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Script.xml. .. _class_Script: @@ -164,7 +164,7 @@ Script .. code-tab:: csharp using Godot; - + [GlobalClass] public partial class MyNode : Node { @@ -230,7 +230,9 @@ Script :ref:`Array`\[:ref:`Dictionary`\] **get_script_method_list**\ (\ ) :ref:`🔗` -返回此 **Script** 中的方法列表。 +返回该 **Script** 中的方法列表。 + +\ **注意：**\ 该方法所返回的字典与 :ref:`Object.get_method_list()` 返回值的格式是一样的。 .. rst-class:: classref-item-separator @@ -242,7 +244,9 @@ Script :ref:`Array`\[:ref:`Dictionary`\] **get_script_property_list**\ (\ ) :ref:`🔗` -返回此 **Script** 中的属性列表。 +返回该 **Script** 中的属性列表。 + +\ **注意：**\ 该方法所返回的字典与 :ref:`Object.get_property_list()` 返回值的格式是一样的。 .. rst-class:: classref-item-separator @@ -254,7 +258,9 @@ Script :ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) :ref:`🔗` -返回在此 **Script** 中定义的用户信号列表。 +返回该 **Script** 中定义的用户信号列表。 + +\ **注意：**\ 该方法所返回的字典与 :ref:`Object.get_signal_list()` 返回值的格式是一样的。 .. rst-class:: classref-item-separator @@ -331,6 +337,7 @@ Script 重新加载脚本的类的实现。返回一个错误代码。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scriptbacktrace.rst b/classes/zh_CN/class_scriptbacktrace.rst new file mode 100644 index 0000000000..4763270919 --- /dev/null +++ b/classes/zh_CN/class_scriptbacktrace.rst @@ -0,0 +1,287 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptBacktrace.xml. + +.. _class_ScriptBacktrace: + +ScriptBacktrace +=============== + +**继承：** :ref:`RefCounted` **<** :ref:`Object` + +捕获的特定脚本语言的追踪信息。 + +.. rst-class:: classref-introduction-group + +描述 +---- + +**ScriptBacktrace** 中包含的是已捕获的追踪信息，针对特定的脚本语言，例如 GDScript、C# 等。捕获的方法是使用 :ref:`Engine.capture_script_backtraces()`\ 。 + +控制该类内容的方法见 :ref:`ProjectSettings.debug/settings/gdscript/always_track_call_stacks` 和 :ref:`ProjectSettings.debug/settings/gdscript/always_track_local_variables`\ 。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format`\ (\ indent_all\: :ref:`int` = 0, indent_frames\: :ref:`int` = 4\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frame_count`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_frame_file`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_frame_function`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frame_line`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_global_variable_count`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_global_variable_name`\ (\ variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_global_variable_value`\ (\ variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language_name`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_variable_count`\ (\ frame_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_local_variable_name`\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_local_variable_value`\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_member_variable_count`\ (\ frame_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_member_variable_name`\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_member_variable_value`\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_ScriptBacktrace_method_format: + +.. rst-class:: classref-method + +:ref:`String` **format**\ (\ indent_all\: :ref:`int` = 0, indent_frames\: :ref:`int` = 4\ ) |const| :ref:`🔗` + +将捕获信息转换为 :ref:`String`\ ，整个字符串都会缩进 ``indent_all`` 个空格，各个栈帧还会额外缩进 ``indent_frames`` 个空格。 + +\ **注意：**\ 对 **ScriptBacktrace** 调用 :ref:`Object.to_string()` 的输出和保持所有默认参数调用 :ref:`format()` 的输出相同。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_frame_count: + +.. rst-class:: classref-method + +:ref:`int` **get_frame_count**\ (\ ) |const| :ref:`🔗` + +返回追踪信息中的栈帧数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_frame_file: + +.. rst-class:: classref-method + +:ref:`String` **get_frame_file**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的栈帧所代表的调用点的文件名。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_frame_function: + +.. rst-class:: classref-method + +:ref:`String` **get_frame_function**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的栈帧所调用的函数名。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_frame_line: + +.. rst-class:: classref-method + +:ref:`int` **get_frame_line**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的栈帧所代表的调用点的行号。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_global_variable_count: + +.. rst-class:: classref-method + +:ref:`int` **get_global_variable_count**\ (\ ) |const| :ref:`🔗` + +返回追踪信息中的全局变量数（例如自动加载单例）。 + +\ **注意：**\ 使用 :ref:`Engine.capture_script_backtraces()` 捕获追踪信息时如果参数 ``include_variables`` 为 ``true``\ ，则数量非零。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_global_variable_name: + +.. rst-class:: classref-method + +:ref:`String` **get_global_variable_name**\ (\ variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的全局变量名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_global_variable_value: + +.. rst-class:: classref-method + +:ref:`Variant` **get_global_variable_value**\ (\ variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的全局变量取值。 + +\ **警告：**\ 在 GDScript 追踪信息中，返回的 :ref:`Variant` 是变量的实际值，包含对象引用。这意味着存储返回的 :ref:`Variant` 会阻止这类对象的释放，因此通常不建议这么做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_language_name: + +.. rst-class:: classref-method + +:ref:`String` **get_language_name**\ (\ ) |const| :ref:`🔗` + +返回捕获信息所捕获的脚本语言的名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_local_variable_count: + +.. rst-class:: classref-method + +:ref:`int` **get_local_variable_count**\ (\ frame_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的栈帧中的局部变量数。 + +\ **注意：**\ 使用 :ref:`Engine.capture_script_backtraces()` 捕获追踪信息时如果参数 ``include_variables`` 为 ``true``\ ，则数量非零。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_local_variable_name: + +.. rst-class:: classref-method + +:ref:`String` **get_local_variable_name**\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``frame_index`` 的栈帧中索引为 ``variable_index`` 的局部变量的名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_local_variable_value: + +.. rst-class:: classref-method + +:ref:`Variant` **get_local_variable_value**\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``frame_index`` 的栈帧中索引为 ``variable_index`` 的局部变量的取值。 + +\ **警告：**\ 在 GDScript 追踪信息中，返回的 :ref:`Variant` 是变量的实际值，包含对象引用。这意味着存储返回的 :ref:`Variant` 会阻止这类对象的释放，因此通常不建议这么做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_member_variable_count: + +.. rst-class:: classref-method + +:ref:`int` **get_member_variable_count**\ (\ frame_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回位于指定索引处的栈帧中的成员变量数。 + +\ **注意：**\ 使用 :ref:`Engine.capture_script_backtraces()` 捕获追踪信息时如果参数 ``include_variables`` 为 ``true``\ ，则数量非零。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_member_variable_name: + +.. rst-class:: classref-method + +:ref:`String` **get_member_variable_name**\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``frame_index`` 的栈帧中索引为 ``variable_index`` 的成员变量的名称。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_get_member_variable_value: + +.. rst-class:: classref-method + +:ref:`Variant` **get_member_variable_value**\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``frame_index`` 的栈帧中索引为 ``variable_index`` 的成员变量的取值。 + +\ **警告：**\ 在 GDScript 追踪信息中，返回的 :ref:`Variant` 是变量的实际值，包含对象引用。这意味着存储返回的 :ref:`Variant` 会阻止这类对象的释放，因此通常不建议这么做。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_is_empty: + +.. rst-class:: classref-method + +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` + +如果追踪信息中没有栈帧，则返回 ``true``\ 。 + +.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` +.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` +.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` +.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` +.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` +.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` +.. |void| replace:: :abbr:`void (无返回值。)` diff --git a/classes/zh_CN/class_scriptcreatedialog.rst b/classes/zh_CN/class_scriptcreatedialog.rst index 50bafbf118..a167b0fad1 100644 --- a/classes/zh_CN/class_scriptcreatedialog.rst +++ b/classes/zh_CN/class_scriptcreatedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptCreateDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptCreateDialog.xml. .. _class_ScriptCreateDialog: @@ -107,6 +107,7 @@ Godot 编辑器用于创建新 :ref:`Script` 文件的弹出对话 预填必填字段以配置 ScriptCreateDialog 以供使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scripteditor.rst b/classes/zh_CN/class_scripteditor.rst index 542b36d4eb..ef70afbda1 100644 --- a/classes/zh_CN/class_scripteditor.rst +++ b/classes/zh_CN/class_scripteditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptEditor.xml. .. _class_ScriptEditor: @@ -31,6 +31,8 @@ Godot 编辑器的脚本编辑器。 .. table:: :widths: auto + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_docs_from_script`\ (\ script\: :ref:`Script`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_breakpoints`\ (\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,6 +95,20 @@ Godot 编辑器的脚本编辑器。 方法说明 -------- +.. _class_ScriptEditor_method_clear_docs_from_script: + +.. rst-class:: classref-method + +|void| **clear_docs_from_script**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` + +移除 ``script`` 脚本的文档。 + +\ **注意：**\ 每当脚本发生更改时都应调用该方法，从而保持打开文档的状态为最新。 + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptEditor_method_get_breakpoints: .. rst-class:: classref-method @@ -246,11 +262,12 @@ Godot 编辑器的脚本编辑器。 |void| **update_docs_from_script**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` -如果 ``script`` 脚本的文档当前是打开状态，则更新该文档。 +为 ``script`` 脚本更新文档。 \ **注意：**\ 每当脚本发生更改时都应调用该方法，从而保持打开文档的状态为最新。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scripteditorbase.rst b/classes/zh_CN/class_scripteditorbase.rst index a4c5c0a283..bd1f2815af 100644 --- a/classes/zh_CN/class_scripteditorbase.rst +++ b/classes/zh_CN/class_scripteditorbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptEditorBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptEditorBase.xml. .. _class_ScriptEditorBase: @@ -175,7 +175,7 @@ ScriptEditorBase |void| **add_syntax_highlighter**\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` -将 :ref:`EditorSyntaxHighlighter` 添加到打开的脚本中。 +为打开的脚本添加 :ref:`EditorSyntaxHighlighter`\ 。 .. rst-class:: classref-item-separator @@ -190,6 +190,7 @@ ScriptEditorBase 返回用于编辑脚本的底层 :ref:`Control`\ 。文本脚本对应 :ref:`CodeEdit`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scriptextension.rst b/classes/zh_CN/class_scriptextension.rst index 589926f188..278e402909 100644 --- a/classes/zh_CN/class_scriptextension.rst +++ b/classes/zh_CN/class_scriptextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptExtension.xml. .. _class_ScriptExtension: @@ -24,81 +24,81 @@ ScriptExtension .. table:: :widths: auto - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_instantiate`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_editor_can_reload_from_file`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`_get_base_script`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_class_icon_path`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_constants`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_doc_class_name`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_documentation`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_global_name`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_instance_base_type`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptLanguage` | :ref:`_get_language`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_member_line`\ (\ member\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`StringName`\] | :ref:`_get_members`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_method_info`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_rpc_config`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_script_method_argument_count`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_method_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_property_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_signal_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_source_code`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_script_signal`\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_source_code`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_static_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_inherits_script`\ (\ script\: :ref:`Script`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``void*`` | :ref:`_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_instance_has`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_abstract`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_tool`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_placeholder_erased`\ (\ placeholder\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``void*`` | :ref:`_placeholder_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_reload`\ (\ keep_state\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_source_code`\ (\ code\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_update_exports`\ (\ ) |virtual| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_instantiate`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_editor_can_reload_from_file`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`_get_base_script`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_class_icon_path`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_constants`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_doc_class_name`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_documentation`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_global_name`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_instance_base_type`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptLanguage` | :ref:`_get_language`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_member_line`\ (\ member\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`_get_members`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_method_info`\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_rpc_config`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_script_method_argument_count`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_method_list`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_property_list`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_signal_list`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_source_code`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_script_signal`\ (\ signal\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_source_code`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_static_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_inherits_script`\ (\ script\: :ref:`Script`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_instance_has`\ (\ object\: :ref:`Object`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_abstract`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_tool`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_placeholder_erased`\ (\ placeholder\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_placeholder_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_reload`\ (\ keep_state\: :ref:`bool`\ ) |virtual| |required| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_source_code`\ (\ code\: :ref:`String`\ ) |virtual| |required| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update_exports`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -113,7 +113,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_can_instantiate**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_can_instantiate**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -127,7 +127,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_editor_can_reload_from_file**\ (\ ) |virtual| :ref:`🔗` +:ref:`bool` **_editor_can_reload_from_file**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -141,7 +141,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Script` **_get_base_script**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Script` **_get_base_script**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -169,7 +169,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Dictionary` **_get_constants**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_get_constants**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -183,7 +183,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`StringName` **_get_doc_class_name**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`StringName` **_get_doc_class_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -197,7 +197,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_documentation**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_documentation**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -211,7 +211,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`StringName` **_get_global_name**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`StringName` **_get_global_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -225,7 +225,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`StringName` **_get_instance_base_type**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`StringName` **_get_instance_base_type**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -239,7 +239,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`ScriptLanguage` **_get_language**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`ScriptLanguage` **_get_language**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -253,7 +253,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`int` **_get_member_line**\ (\ member\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_member_line**\ (\ member\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -267,7 +267,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **_get_members**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`StringName`\] **_get_members**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -281,7 +281,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Dictionary` **_get_method_info**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_get_method_info**\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -295,7 +295,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Variant` **_get_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_get_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -309,7 +309,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Variant` **_get_rpc_config**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Variant` **_get_rpc_config**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -335,7 +335,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_method_list**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_method_list**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -349,7 +349,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_property_list**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_property_list**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -363,7 +363,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_signal_list**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_signal_list**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -377,7 +377,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`String` **_get_source_code**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_source_code**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -391,7 +391,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_has_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -405,7 +405,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_has_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -419,7 +419,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_has_script_signal**\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_script_signal**\ (\ signal\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -433,7 +433,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_has_source_code**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_source_code**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -447,7 +447,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_has_static_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_static_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -461,7 +461,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_inherits_script**\ (\ script\: :ref:`Script`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_inherits_script**\ (\ script\: :ref:`Script`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -475,7 +475,7 @@ ScriptExtension .. rst-class:: classref-method -``void*`` **_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` +``void*`` **_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -489,7 +489,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_instance_has**\ (\ object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_instance_has**\ (\ object\: :ref:`Object`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -505,7 +505,7 @@ ScriptExtension :ref:`bool` **_is_abstract**\ (\ ) |virtual| |const| :ref:`🔗` -如果脚本是抽象脚本，则返回 ``true``\ 。抽象脚本没有构造函数，无法被实例化。 +如果脚本为抽象脚本，则返回 ``true``\ 。抽象脚本无法直接实例化，而是需要用其他脚本继承。抽象脚本在“创建新节点”对话框中无法选中或不可见（存在非抽象类继承时无法选中，否则隐藏）。 .. rst-class:: classref-item-separator @@ -515,7 +515,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_is_placeholder_fallback_enabled**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_placeholder_fallback_enabled**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -529,7 +529,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_is_tool**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_tool**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -543,7 +543,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`bool` **_is_valid**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_valid**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -571,7 +571,7 @@ ScriptExtension .. rst-class:: classref-method -``void*`` **_placeholder_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` +``void*`` **_placeholder_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -585,7 +585,7 @@ ScriptExtension .. rst-class:: classref-method -:ref:`Error` **_reload**\ (\ keep_state\: :ref:`bool`\ ) |virtual| :ref:`🔗` +:ref:`Error` **_reload**\ (\ keep_state\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -599,7 +599,7 @@ ScriptExtension .. rst-class:: classref-method -|void| **_set_source_code**\ (\ code\: :ref:`String`\ ) |virtual| :ref:`🔗` +|void| **_set_source_code**\ (\ code\: :ref:`String`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -613,13 +613,14 @@ ScriptExtension .. rst-class:: classref-method -|void| **_update_exports**\ (\ ) |virtual| :ref:`🔗` +|void| **_update_exports**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scriptlanguage.rst b/classes/zh_CN/class_scriptlanguage.rst index 66d114bb86..22d7383d88 100644 --- a/classes/zh_CN/class_scriptlanguage.rst +++ b/classes/zh_CN/class_scriptlanguage.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptLanguage.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptLanguage.xml. .. _class_ScriptLanguage: @@ -81,7 +81,20 @@ enum **ScriptNameCasing**: :ref:`🔗` +.. _class_ScriptLanguage_constant_SCRIPT_NAME_CASING_CAMEL_CASE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScriptNameCasing` **SCRIPT_NAME_CASING_CAMEL_CASE** = ``4`` + +.. container:: contribute + + 该枚举目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ + + + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scriptlanguageextension.rst b/classes/zh_CN/class_scriptlanguageextension.rst index c81740c468..ac70beb8c4 100644 --- a/classes/zh_CN/class_scriptlanguageextension.rst +++ b/classes/zh_CN/class_scriptlanguageextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScriptLanguageExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptLanguageExtension.xml. .. _class_ScriptLanguageExtension: @@ -24,127 +24,127 @@ ScriptLanguageExtension .. table:: :widths: auto - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_add_named_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_auto_indent_code`\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_inherit_from_file`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_make_function`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_complete_code`\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_create_script`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_debug_get_current_stack_info`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_get_error`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_globals`\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_debug_get_stack_level_count`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_get_stack_level_function`\ (\ level\: :ref:`int`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``void*`` | :ref:`_debug_get_stack_level_instance`\ (\ level\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_debug_get_stack_level_line`\ (\ level\: :ref:`int`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_stack_level_locals`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_stack_level_members`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_get_stack_level_source`\ (\ level\: :ref:`int`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_parse_stack_level_expression`\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_find_function`\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_finish`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_frame`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_built_in_templates`\ (\ object\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_doc_comment_delimiters`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_extension`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_global_class_name`\ (\ path\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_annotations`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_public_constants`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_functions`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_reserved_words`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_string_delimiters`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_type`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles_global_class_type`\ (\ type\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_named_classes`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_init`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_control_flow_keyword`\ (\ keyword\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_using_templates`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_lookup_code`\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_make_function`\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`_make_template`\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_open_in_external_editor`\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_overrides_external_editor`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptNameCasing` | :ref:`_preferred_file_name_casing`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_profiling_get_accumulated_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_profiling_get_frame_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_profiling_set_save_native_calls`\ (\ enable\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_profiling_start`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_profiling_stop`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_reload_all_scripts`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_reload_scripts`\ (\ scripts\: :ref:`Array`, soft_reload\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_reload_tool_script`\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_remove_named_global_constant`\ (\ name\: :ref:`StringName`\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_supports_builtin_mode`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_supports_documentation`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_thread_enter`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_thread_exit`\ (\ ) |virtual| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_validate`\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_validate_path`\ (\ path\: :ref:`String`\ ) |virtual| |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_named_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_auto_indent_code`\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_inherit_from_file`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_make_function`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_complete_code`\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_create_script`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_debug_get_current_stack_info`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_error`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_globals`\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_debug_get_stack_level_count`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_stack_level_function`\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_debug_get_stack_level_instance`\ (\ level\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_debug_get_stack_level_line`\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_stack_level_locals`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_stack_level_members`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_stack_level_source`\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_parse_stack_level_expression`\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_find_function`\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_frame`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_built_in_templates`\ (\ object\: :ref:`StringName`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_doc_comment_delimiters`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_extension`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_global_class_name`\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_annotations`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_public_constants`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_functions`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_reserved_words`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_string_delimiters`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_type`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles_global_class_type`\ (\ type\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_named_classes`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_control_flow_keyword`\ (\ keyword\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_using_templates`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_lookup_code`\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_make_function`\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`_make_template`\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_open_in_external_editor`\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_overrides_external_editor`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptNameCasing` | :ref:`_preferred_file_name_casing`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_profiling_get_accumulated_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_profiling_get_frame_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_set_save_native_calls`\ (\ enable\: :ref:`bool`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_start`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_stop`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reload_all_scripts`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reload_scripts`\ (\ scripts\: :ref:`Array`, soft_reload\: :ref:`bool`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reload_tool_script`\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_named_global_constant`\ (\ name\: :ref:`StringName`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_supports_builtin_mode`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_supports_documentation`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_thread_enter`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_thread_exit`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_validate`\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_validate_path`\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -500,7 +500,7 @@ enum **CodeCompletionKind**: :ref:`🔗`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_add_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -514,7 +514,7 @@ enum **CodeCompletionKind**: :ref:`🔗`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` +|void| **_add_named_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -528,7 +528,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_auto_indent_code**\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_auto_indent_code**\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -542,7 +542,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_can_inherit_from_file**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_can_inherit_from_file**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -556,7 +556,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_can_make_function**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_can_make_function**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -570,7 +570,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_complete_code**\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_complete_code**\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -584,7 +584,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_create_script**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Object` **_create_script**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -598,7 +598,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\[:ref:`Dictionary`\] **_debug_get_current_stack_info**\ (\ ) |virtual| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_debug_get_current_stack_info**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -612,7 +612,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_error**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_debug_get_error**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -626,7 +626,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_globals**\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Dictionary` **_debug_get_globals**\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -640,7 +640,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_count**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_debug_get_stack_level_count**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -654,7 +654,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_function**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_debug_get_stack_level_function**\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -668,7 +668,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\ ) |virtual| :ref:`🔗` +``void*`` **_debug_get_stack_level_instance**\ (\ level\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -682,7 +682,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_line**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_debug_get_stack_level_line**\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -696,7 +696,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_locals**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Dictionary` **_debug_get_stack_level_locals**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -710,7 +710,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_members**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Dictionary` **_debug_get_stack_level_members**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -724,7 +724,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_get_stack_level_source**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_debug_get_stack_level_source**\ (\ level\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回与给定调试堆栈位置相关的源。 @@ -736,7 +736,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_debug_parse_stack_level_expression**\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`String` **_debug_parse_stack_level_expression**\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -750,7 +750,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_find_function**\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_find_function**\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` 返回代码中定义该函数的行，如果该函数不存在，则返回 ``-1``\ 。 @@ -762,7 +762,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_finish**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -776,7 +776,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_frame**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -790,7 +790,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\[:ref:`Dictionary`\] **_get_built_in_templates**\ (\ object\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_built_in_templates**\ (\ object\: :ref:`StringName`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -804,7 +804,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_comment_delimiters**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedStringArray` **_get_comment_delimiters**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -832,7 +832,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_extension**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_extension**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -846,7 +846,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_global_class_name**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_get_global_class_name**\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -860,7 +860,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -874,7 +874,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\[:ref:`Dictionary`\] **_get_public_annotations**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_annotations**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -888,7 +888,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_public_constants**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_get_public_constants**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -902,7 +902,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\[:ref:`Dictionary`\] **_get_public_functions**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_functions**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -916,7 +916,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -930,7 +930,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_reserved_words**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedStringArray` **_get_reserved_words**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -944,7 +944,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_string_delimiters**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`PackedStringArray` **_get_string_delimiters**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -958,7 +958,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_get_type**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_get_type**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -972,7 +972,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_handles_global_class_type**\ (\ type\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_handles_global_class_type**\ (\ type\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -986,7 +986,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_has_named_classes**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_named_classes**\ (\ ) |virtual| |required| |const| :ref:`🔗` **已弃用：** This method is not called by the engine. @@ -998,7 +998,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_init**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1012,7 +1012,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_is_control_flow_keyword**\ (\ keyword\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_is_control_flow_keyword**\ (\ keyword\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1026,7 +1026,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_is_using_templates**\ (\ ) |virtual| :ref:`🔗` +:ref:`bool` **_is_using_templates**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1040,7 +1040,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_lookup_code**\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_lookup_code**\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1054,7 +1054,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_make_function**\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_make_function**\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1068,7 +1068,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_make_template**\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`Script` **_make_template**\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1082,7 +1082,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_open_in_external_editor**\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`Error` **_open_in_external_editor**\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1096,7 +1096,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_overrides_external_editor**\ (\ ) |virtual| :ref:`🔗` +:ref:`bool` **_overrides_external_editor**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1124,7 +1124,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_profiling_get_accumulated_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_profiling_get_accumulated_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1138,7 +1138,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_profiling_get_frame_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| :ref:`🔗` +:ref:`int` **_profiling_get_frame_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1152,7 +1152,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\ ) |virtual| :ref:`🔗` +|void| **_profiling_set_save_native_calls**\ (\ enable\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1166,7 +1166,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_profiling_start**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1180,7 +1180,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_profiling_stop**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1194,7 +1194,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_reload_all_scripts**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1208,7 +1208,7 @@ enum **CodeCompletionKind**: :ref:`🔗`, soft_reload\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_reload_scripts**\ (\ scripts\: :ref:`Array`, soft_reload\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1222,7 +1222,7 @@ enum **CodeCompletionKind**: :ref:`🔗`, soft_reload\: :ref:`bool`\ ) |virtual| :ref:`🔗` +|void| **_reload_tool_script**\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1236,7 +1236,7 @@ enum **CodeCompletionKind**: :ref:`🔗`\ ) |virtual| :ref:`🔗` +|void| **_remove_named_global_constant**\ (\ name\: :ref:`StringName`\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1250,7 +1250,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_supports_builtin_mode**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_supports_builtin_mode**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1264,7 +1264,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_supports_documentation**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_supports_documentation**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1278,7 +1278,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_thread_enter**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1292,7 +1292,7 @@ enum **CodeCompletionKind**: :ref:`🔗` +|void| **_thread_exit**\ (\ ) |virtual| |required| :ref:`🔗` .. container:: contribute @@ -1306,7 +1306,7 @@ enum **CodeCompletionKind**: :ref:`🔗` **_validate**\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` +:ref:`Dictionary` **_validate**\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -1320,13 +1320,14 @@ enum **CodeCompletionKind**: :ref:`🔗` **_validate_path**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` +:ref:`String` **_validate_path**\ (\ path\: :ref:`String`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scrollbar.rst b/classes/zh_CN/class_scrollbar.rst index 5a867fbcbc..0d0887bb78 100644 --- a/classes/zh_CN/class_scrollbar.rst +++ b/classes/zh_CN/class_scrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScrollBar.xml. .. _class_ScrollBar: @@ -31,11 +31,13 @@ ScrollBar .. table:: :widths: auto - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ - | :ref:`float` | :ref:`custom_step` | ``-1.0`` | - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ - | :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | :ref:`custom_step` | ``-1.0`` | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -246,6 +248,7 @@ ScrollBar 当 **ScrollBar** 具有 GUI 焦点时用作背景。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_scrollcontainer.rst b/classes/zh_CN/class_scrollcontainer.rst index 970d21664c..b49a55c1fe 100644 --- a/classes/zh_CN/class_scrollcontainer.rst +++ b/classes/zh_CN/class_scrollcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ScrollContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScrollContainer.xml. .. _class_ScrollContainer: @@ -232,7 +232,7 @@ enum **ScrollMode**: :ref:`🔗` - |void| **set_horizontal_scroll_mode**\ (\ value\: :ref:`ScrollMode`\ ) - :ref:`ScrollMode` **get_horizontal_scroll_mode**\ (\ ) -控制水平滚动条是否可用、应该何时可见。选项见 :ref:`ScrollMode`\ 。 +控制水平滚动条是否可用、应该何时可见。 .. rst-class:: classref-item-separator @@ -348,7 +348,7 @@ enum **ScrollMode**: :ref:`🔗` - |void| **set_vertical_scroll_mode**\ (\ value\: :ref:`ScrollMode`\ ) - :ref:`ScrollMode` **get_vertical_scroll_mode**\ (\ ) -控制垂直滚动条是否可用、应该何时可见。选项见 :ref:`ScrollMode`\ 。 +控制垂直滚动条是否可用、应该何时可见。 .. rst-class:: classref-section-separator @@ -433,6 +433,7 @@ enum **ScrollMode**: :ref:`🔗` **ScrollContainer** 的背景 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_segmentshape2d.rst b/classes/zh_CN/class_segmentshape2d.rst index 4287c39476..2d90df17f7 100644 --- a/classes/zh_CN/class_segmentshape2d.rst +++ b/classes/zh_CN/class_segmentshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SegmentShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SegmentShape2D.xml. .. _class_SegmentShape2D: @@ -75,6 +75,7 @@ SegmentShape2D 该段的第二个点的位置。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_semaphore.rst b/classes/zh_CN/class_semaphore.rst index 664ef8d220..e5ad85494a 100644 --- a/classes/zh_CN/class_semaphore.rst +++ b/classes/zh_CN/class_semaphore.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Semaphore.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Semaphore.xml. .. _class_Semaphore: @@ -96,6 +96,7 @@ Semaphore 等待该 **Semaphore**\ ，如果它的值为零，则阻塞到变为非零为止。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_separationrayshape2d.rst b/classes/zh_CN/class_separationrayshape2d.rst index 7deae7bcb6..20469d6827 100644 --- a/classes/zh_CN/class_separationrayshape2d.rst +++ b/classes/zh_CN/class_separationrayshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SeparationRayShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SeparationRayShape2D.xml. .. _class_SeparationRayShape2D: @@ -77,6 +77,7 @@ SeparationRayShape2D 如果为 ``true``\ ，则该形状可以返回正确的法线，并在任何方向上分离，允许在斜坡上滑动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_separationrayshape3d.rst b/classes/zh_CN/class_separationrayshape3d.rst index 706e5a15cd..71dbb02165 100644 --- a/classes/zh_CN/class_separationrayshape3d.rst +++ b/classes/zh_CN/class_separationrayshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SeparationRayShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SeparationRayShape3D.xml. .. _class_SeparationRayShape3D: @@ -77,6 +77,7 @@ SeparationRayShape3D 如果为 ``true``\ ，则该形状可以返回正确的法线，并在任何方向上分离，允许在斜坡上滑动。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_separator.rst b/classes/zh_CN/class_separator.rst index b174bc2ab2..7301a2415c 100644 --- a/classes/zh_CN/class_separator.rst +++ b/classes/zh_CN/class_separator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Separator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Separator.xml. .. _class_Separator: @@ -67,6 +67,7 @@ Separator 分隔线的样式。与 :ref:`StyleBoxLine` 一起使用效果最好（请记住为 :ref:`VSeparator` 启用 :ref:`StyleBoxLine.vertical`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shader.rst b/classes/zh_CN/class_shader.rst index 1d379ca919..3649de2d49 100644 --- a/classes/zh_CN/class_shader.rst +++ b/classes/zh_CN/class_shader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Shader.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shader.xml. .. _class_Shader: @@ -217,6 +217,7 @@ enum **Mode**: :ref:`🔗` \ **注意：**\ 如果使用采样器数组，则使用 ``index`` 访问指定的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shaderglobalsoverride.rst b/classes/zh_CN/class_shaderglobalsoverride.rst index 36602c5946..429251bf6b 100644 --- a/classes/zh_CN/class_shaderglobalsoverride.rst +++ b/classes/zh_CN/class_shaderglobalsoverride.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShaderGlobalsOverride.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderGlobalsOverride.xml. .. _class_ShaderGlobalsOverride: @@ -33,6 +33,7 @@ ShaderGlobalsOverride - :doc:`着色语言 <../tutorials/shaders/shader_reference/shading_language>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shaderinclude.rst b/classes/zh_CN/class_shaderinclude.rst index 4918b005d4..69c9f5d0b9 100644 --- a/classes/zh_CN/class_shaderinclude.rst +++ b/classes/zh_CN/class_shaderinclude.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShaderInclude.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderInclude.xml. .. _class_ShaderInclude: @@ -63,6 +63,7 @@ ShaderInclude 返回着色器头文件的代码。返回的文本是用户所编写的内容，不是内部使用的完整生成的代码。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shaderincludedb.rst b/classes/zh_CN/class_shaderincludedb.rst index 3683e65f48..188f5a691e 100644 --- a/classes/zh_CN/class_shaderincludedb.rst +++ b/classes/zh_CN/class_shaderincludedb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShaderIncludeDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderIncludeDB.xml. .. _class_ShaderIncludeDB: @@ -79,6 +79,7 @@ ShaderIncludeDB 返回目前已注册的内置头文件列表。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shadermaterial.rst b/classes/zh_CN/class_shadermaterial.rst index ccc1ffa430..1f9e31fb03 100644 --- a/classes/zh_CN/class_shadermaterial.rst +++ b/classes/zh_CN/class_shadermaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShaderMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderMaterial.xml. .. _class_ShaderMaterial: @@ -114,6 +114,7 @@ ShaderMaterial \ **注意：**\ 对着色器 uniform 的修改会在使用这个 **ShaderMaterial** 的所有实例上生效。要防止这种行为，请通过 :ref:`GeometryInstance3D.set_instance_shader_parameter()` 使用单实例 uniform，或者使用 :ref:`Resource.duplicate()` 制作该 **ShaderMaterial** 的副本。单实例 uniform 可以更好地复用着色器，因此速度也更快，所以应该尽可能优先使用，而不是制作 **ShaderMaterial** 的副本。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shape2d.rst b/classes/zh_CN/class_shape2d.rst index d157ba5545..28ff88ba00 100644 --- a/classes/zh_CN/class_shape2d.rst +++ b/classes/zh_CN/class_shape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Shape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shape2D.xml. .. _class_Shape2D: @@ -184,6 +184,7 @@ Shape2D 返回代表形状边界的 :ref:`Rect2`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shape3d.rst b/classes/zh_CN/class_shape3d.rst index c3bfb960bb..3da2ceea2d 100644 --- a/classes/zh_CN/class_shape3d.rst +++ b/classes/zh_CN/class_shape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Shape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shape3D.xml. .. _class_Shape3D: @@ -119,6 +119,7 @@ Shape3D 返回用于绘制此 **Shape3D** 的调试碰撞的 :ref:`ArrayMesh`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shapecast2d.rst b/classes/zh_CN/class_shapecast2d.rst index 9a728c7679..a7132ae63e 100644 --- a/classes/zh_CN/class_shapecast2d.rst +++ b/classes/zh_CN/class_shapecast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShapeCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast2D.xml. .. _class_ShapeCast2D: @@ -489,6 +489,7 @@ ShapeCast2D 根据 ``value``\ ，启用或禁用 :ref:`collision_mask` 中指定的层，给定的 ``layer_number`` 应在 1 和 32 之间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shapecast3d.rst b/classes/zh_CN/class_shapecast3d.rst index 63d100674f..0842d95d77 100644 --- a/classes/zh_CN/class_shapecast3d.rst +++ b/classes/zh_CN/class_shapecast3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ShapeCast3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast3D.xml. .. _class_ShapeCast3D: @@ -526,6 +526,7 @@ ShapeCast3D 根据 ``value``\ ，启用或禁用 :ref:`collision_mask` 中指定的层，给定的 ``layer_number`` 应在 1 和 32 之间。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_shortcut.rst b/classes/zh_CN/class_shortcut.rst index 5fdad5a650..1aaa250be1 100644 --- a/classes/zh_CN/class_shortcut.rst +++ b/classes/zh_CN/class_shortcut.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Shortcut.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shortcut.xml. .. _class_Shortcut: @@ -19,9 +19,65 @@ Shortcut 描述 ---- -快捷键通常用于通过 :ref:`InputEvent` 与 :ref:`Control` 元素进行交互（也叫热键）。 +Shortcut（快捷键，也叫热键）是 :ref:`InputEvent` 资源的容器，常用于通过 :ref:`InputEvent` 与 :ref:`Control` 元素进行交互。 + +一个快捷键可以包含多个 :ref:`InputEvent` 资源，因此可以使用多种不同的输入触发某个动作。 + +\ **示例：**\ 使用 **Shortcut** 资源捕获 :kbd:`Ctrl + S` 快捷键： + + +.. tabs:: + + .. code-tab:: gdscript + + extends Node + + var save_shortcut = Shortcut.new() + func _ready(): + var key_event = InputEventKey.new() + key_event.keycode = KEY_S + key_event.ctrl_pressed = true + key_event.command_or_control_autoremap = true # 在 mac 上将 Ctrl 替换为 Command。 + save_shortcut.events = [key_event] + + func _input(event): + if save_shortcut.matches_event(event) and event.is_pressed() and not event.is_echo(): + print("按下了保存快捷键！") + get_viewport().set_input_as_handled() + + .. code-tab:: csharp + + using Godot; + + public partial class MyNode : Node + { + private readonly Shortcut _saveShortcut = new Shortcut(); + + public override void _Ready() + { + InputEventKey keyEvent = new InputEventKey + { + Keycode = Key.S, + CtrlPressed = true, + CommandOrControlAutoremap = true, // 在 mac 上将 Ctrl 替换为 Command。 + }; + + _saveShortcut.Events = [keyEvent]; + } + + public override void _Input(InputEvent @event) + { + if (@event is InputEventKey keyEvent && + _saveShortcut.MatchesEvent(@event) && + keyEvent.Pressed && !keyEvent.Echo) + { + GD.Print("按下了保存快捷键！"); + GetViewport().SetInputAsHandled(); + } + } + } + -一个快捷键可以包含多个 :ref:`InputEvent`\ ，因此能够使用多种不同的输入触发某个动作。 .. rst-class:: classref-reftable-group @@ -117,6 +173,7 @@ Shortcut 返回 :ref:`events` 中是否有等于 ``event`` 的 :ref:`InputEvent`\ 。比较事件时使用 :ref:`InputEvent.is_match()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_signal.rst b/classes/zh_CN/class_signal.rst index 81b50ea350..290fcaf705 100644 --- a/classes/zh_CN/class_signal.rst +++ b/classes/zh_CN/class_signal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Signal.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Signal.xml. .. _class_Signal: @@ -17,9 +17,9 @@ Signal 描述 ---- -信号 **Signal** 是内置的 :ref:`Variant` 类型，代表 :ref:`Object` 实例的某个信息。信号和所有 :ref:`Variant` 类型一样，可以在变量中存储、传递给函数。信号能够让所有连接的 :ref:`Callable`\ （及相应扩展对象）监听事件并作出反应，不必直接互相引用。这样就能让代码更灵活、更易于管理。你可以使用 :ref:`Object.has_signal()` 来判断 :ref:`Object` 是否存在给定名称的信号。 +**Signal** 即信号，是一种内置的 :ref:`Variant` 类型，代表某个 :ref:`Object` 实例上的某个信号。与所有 :ref:`Variant` 一样，信号可以存储在变量中也可以传递给函数。所有连接到该信号的 :ref:`Callable`\ （以及扩展出的相应对象）都可以监听事件并对事件进行响应，无需相互直接引用。这样代码就更加灵活，便于管理。你可以使用 :ref:`Object.has_signal()` 来检查某个 :ref:`Object` 对象是否有特定名称的信号。 -在 GDScript 中，信号可以使用 ``signal`` 关键字声明。在 C# 中，你可以在代理上使用 ``[Signal]`` 属性。 +在 GDScript 中，信号可以使用 ``signal`` 关键字声明。在 C# 中，你可以对委托使用 ``[Signal]`` 特性。 .. tabs:: @@ -27,23 +27,167 @@ Signal .. code-tab:: gdscript signal attacked - - # 可以声明额外的参数。 - # 这些参数必须在发出信号时传递。 + + # 还可以额外声明参数。 + # 发出信号时必须传入这些参数。 signal item_dropped(item_name, amount) .. code-tab:: csharp [Signal] delegate void AttackedEventHandler(); - - // 可以声明额外的参数。 - // 这些参数必须在发出信号时传递。 + + // 还可以额外声明参数。 + // 发出信号时必须传入这些参数。 [Signal] delegate void ItemDroppedEventHandler(string itemName, int amount); +连接信号是 Godot 中最常见的操作之一，API 为此提供了许多选项，详见下文。下面的代码展示的是推荐的做法。 + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + var button = Button.new() + # 这里的 `button_down` 是 Signal Variant 类型。因此调用的是 Signal.connect() 方法而不是 Object.connect() 方法。 + # 对该 API 的概述见下面的讨论。 + button.button_down.connect(_on_button_down) + + # 假设存在 `Player` 类，定义了 `hit` 信号。 + var player = Player.new() + # 我们再次使用 Signal.connect()，还使用了 Callable.bind() 方法， + # 返回的是绑定了参数的新 Callable。 + player.hit.connect(_on_player_hit.bind("sword", 100)) + + func _on_button_down(): + print("按下了按钮！") + + func _on_player_hit(weapon_type, damage): + print("使用武器 %s 造成了 %d 点伤害。" % [weapon_type, damage]) + + .. code-tab:: csharp + + public override void _Ready() + { + var button = new Button(); + // C# 支持将信号以事件的形式传递，因此我们可以这么写： + button.ButtonDown += OnButtonDown; + + // 假设存在 `Player` 类，定义了 `hit` 信号。 + var player = new Player(); + // 需要绑定额外参数时可以使用 lambda。 + player.Hit += () => OnPlayerHit("sword", 100); + } + + private void OnButtonDown() + { + GD.Print("按下了按钮！"); + } + + private void OnPlayerHit(string weaponType, int damage) + { + GD.Print($"使用武器 {weaponType} 造成了 {damage} 点伤害。"); + } + + + +\ **\ ``Object.connect()`` 还是 ``Signal.connect()``?**\ + +如上所示，并不推荐使用 :ref:`Object.connect()` 来连接信号。下面的代码中展示了连接信号的四种方法，包括这种传统的方法、推荐的 :ref:`connect()` 方法、使用隐式 :ref:`Callable`\ 、以及手动定义。 + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + var button = Button.new() + # 方法 1：Object.connect() 与方法的隐式 Callable。 + button.connect("button_down", _on_button_down) + # 方法 2：Object.connect() 与使用目标对象和方法名构造的 Callable。 + button.connect("button_down", Callable(self, "_on_button_down")) + # 方法 3：Signal.connect() 与方法的隐式 Callable。 + button.button_down.connect(_on_button_down) + # 方法 4：Signal.connect() 与使用目标对象和方法名构造的 Callable。 + button.button_down.connect(Callable(self, "_on_button_down")) + + func _on_button_down(): + print("Button down!") + + .. code-tab:: csharp + + public override void _Ready() + { + var button = new Button(); + // 方法 1：在 C# 中，我们可以将信号以事件的形式使用，因此我们可以这么连接： + button.ButtonDown += OnButtonDown; + // 方法 2：GodotObject.Connect() 与方法组构造的 Callable。 + button.Connect(Button.SignalName.ButtonDown, Callable.From(OnButtonDown)); + // 方法 3：GodotObject.Connect() 与使用目标对象和方法名构造的 Callable。 + button.Connect(Button.SignalName.ButtonDown, new Callable(this, MethodName.OnButtonDown)); + } + + private void OnButtonDown() + { + GD.Print("按下了按钮！"); + } + + + +所有方法的效果都是一样的（\ ``button`` 的 :ref:`BaseButton.button_down` 信号连接到 ``_on_button_down``\ ），\ **方法 3** 的校验最为完善：如果 ``button_down`` **Signal** 或 ``_on_button_down`` :ref:`Callable` 未定义就会输出编译错误。而\ **方法 2** 仅依赖字符串名称，只能在运行时校验名称：如果 ``"button_down"`` 不是信号或者 ``"_on_button_down"`` 不是 ``self`` 对象的方法，就会在运行时生成错误。使用方法 1、2、4 的主要原因是确实需要使用字符串（例如根据从配置文件读取的字符串通过程序来连接信号）。否则建议使用方法 3（而且速度最快）。 + +\ **参数的绑定和传递：**\ + +绑定参数的语法需要使用 :ref:`Callable.bind()`\ ，返回的是当前 :ref:`Callable` 绑定参数后的副本。 + +调用 :ref:`emit()` 或 :ref:`Object.emit_signal()` 时也可以传递信号的参数。下面的例子展示的是信号参数和绑定参数之间的关系。 + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + # 假设存在 `Player` 类，定义了 `hit` 信号。 + var player = Player.new() + # 使用 Callable.bind()。 + player.hit.connect(_on_player_hit.bind("sword", 100)) + + # 发出信号时添加的参数先传递。 + player.hit.emit("Dark lord", 5) + + # 发出信号时传入了 (`hit_by`, `level`) 两个参数， + # 连接信号时绑定了 (`weapon_type`, `damage`) 两个参数。 + func _on_player_hit(hit_by, level, weapon_type, damage): + print("受到来自 %s（%d 级）的攻击，使用武器 %s 造成了 %d 点伤害。" % [hit_by, level, weapon_type, damage]) + + .. code-tab:: csharp + + public override void _Ready() + { + // 假设存在 `Player` 类，定义了 `hit` 信号。 + var player = new Player(); + // 使用 lambda 表达式创建闭包，捕获额外参数。 + // Lambda 只会接受信号委托定义的参数。 + player.Hit += (hitBy, level) => OnPlayerHit(hitBy, level, "sword", 100); + + // 发出信号时添加的参数先传递。 + player.EmitSignal(SignalName.Hit, "Dark lord", 5); + } + + // 发出信号时传入了 (`hit_by`, `level`) 两个参数， + // 连接信号时绑定了 (`weapon_type`, `damage`) 两个参数。 + private void OnPlayerHit(string hitBy, int level, string weaponType, int damage) + { + GD.Print($"受到来自 {hitBy}（{level} 级）的攻击，使用武器 {weaponType} 造成了 {damage} 点伤害。"); + } + + + .. note:: 通过 C# 使用该 API 时会有显著不同，详见 :ref:`doc_c_sharp_differences`\ 。 @@ -152,7 +296,7 @@ Signal :ref:`Signal` **Signal**\ (\ object\: :ref:`Object`, signal\: :ref:`StringName`\ ) -在指定对象 ``object`` 中新建 **Signal** 对象，引用名为 ``signal`` 的信号。 +新建 **Signal** 对象，引用 ``object`` 对象中名为 ``signal`` 的信号。 .. rst-class:: classref-section-separator @@ -169,17 +313,19 @@ Signal :ref:`int` **connect**\ (\ callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) :ref:`🔗` -将此信号连接到指定的 ``callable``\ 。还可以添加 ``flags`` 对连接的行为进行配置（见 :ref:`ConnectFlags` 常量）。可以使用 :ref:`Callable.bind()` 为连接的 ``callable`` 提供额外的参数。 +将信号连接到可调用体 ``callable``\ 。还可以添加 ``flags`` 对连接的行为进行配置（见 :ref:`ConnectFlags` 常量）。可以使用 :ref:`Callable.bind()` 为连接的 ``callable`` 提供额外的参数。 -一个信号只能和同一个 :ref:`Callable` 连接一次。如果该信号已连接，则会返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER` 并推入错误消息，除非信号是用 :ref:`Object.CONNECT_REFERENCE_COUNTED` 连接的。要防止这个问题，请先使用 :ref:`is_connected()` 检查已有连接。 +一个信号只能和同一个 :ref:`Callable` 连接一次。如果信号已连接，则会返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER` 并生成错误，除非信号是用 :ref:`Object.CONNECT_REFERENCE_COUNTED` 连接的。要防止这个问题，请先使用 :ref:`is_connected()` 检查已有连接。 :: for button in $Buttons.get_children(): button.pressed.connect(_on_pressed.bind(button)) - + func _on_pressed(button): - print(button.name, " 被按下了") + print(button.name, " 被按了一下") + +\ **注意：**\ 如果 ``callable`` 的对象被释放，连接会丢失。 .. rst-class:: classref-item-separator @@ -325,6 +471,7 @@ Signal 如果信号的对象和名称相同，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeleton2d.rst b/classes/zh_CN/class_skeleton2d.rst index 2b4d492f47..6e9b4d676b 100644 --- a/classes/zh_CN/class_skeleton2d.rst +++ b/classes/zh_CN/class_skeleton2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Skeleton2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skeleton2D.xml. .. _class_Skeleton2D: @@ -179,6 +179,7 @@ Skeleton2D 设置附加到此骨架的 :ref:`SkeletonModificationStack2D`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeleton3d.rst b/classes/zh_CN/class_skeleton3d.rst index 9734cdcb53..e2f1f89599 100644 --- a/classes/zh_CN/class_skeleton3d.rst +++ b/classes/zh_CN/class_skeleton3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Skeleton3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skeleton3D.xml. .. _class_Skeleton3D: @@ -61,6 +61,8 @@ Skeleton3D +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_bone`\ (\ name\: :ref:`String`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`advance`\ (\ delta\: :ref:`float`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_bones`\ (\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_bones_global_pose_override`\ (\ ) | @@ -181,9 +183,7 @@ Skeleton3D **bone_list_changed**\ (\ ) :ref:`🔗` -.. container:: contribute - - 该信号目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧 ！ +骨骼列表发生改变时发出，例如当调用 :ref:`add_bone()`\ 、\ :ref:`set_bone_parent()`\ 、\ :ref:`unparent_bone_and_rest()`\ 、\ :ref:`clear_bones()` 时。 .. rst-class:: classref-item-separator @@ -268,6 +268,14 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗`\ ）。 +.. _class_Skeleton3D_constant_MODIFIER_CALLBACK_MODE_PROCESS_MANUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`ModifierCallbackModeProcess` **MODIFIER_CALLBACK_MODE_PROCESS_MANUAL** = ``2`` + +不处理修改。请使用 :ref:`advance()` 手动处理修改。 + .. rst-class:: classref-section-separator ---- @@ -387,6 +395,20 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗`\ ) :ref:`🔗` + +手动将子 :ref:`SkeletonModifier3D` 推进指定的时间（单位为秒）。 + +\ **注意：**\ **Skeleton3D** 中会临时累积 ``delta``\ ，推迟的处理会使用累积值处理修改。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_clear_bones: .. rst-class:: classref-method @@ -549,7 +571,7 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗` **get_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`\ ) |const| :ref:`🔗` -返回 ``bone_idx`` 骨骼中键名为 ``key`` 的元数据。 +返回索引为 ``bone_idx`` 的骨骼中键名为 ``key`` 的元数据。 .. rst-class:: classref-item-separator @@ -561,7 +583,7 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗`\[:ref:`StringName`\] **get_bone_meta_list**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` -返回 ``bone_idx`` 骨骼的所有元数据键名。 +返回索引为 ``bone_idx`` 的骨骼中所有元数据的键名。 .. rst-class:: classref-item-separator @@ -703,7 +725,7 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗` **has_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`\ ) |const| :ref:`🔗` -返回 ``bone_idx`` 骨骼是否存在键名为 ``key`` 的元数据。 +如果索引为 ``bone_idx`` 的骨骼中存在键名为 ``key`` 的元数据，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -881,7 +903,7 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗`, key\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` -将 ``bone_idx`` 骨骼中键名为 ``key`` 的元数据设置为 ``value``\ 。 +将索引为 ``bone_idx`` 的骨骼中键名为 ``key`` 的元数据设置为 ``value``\ 。 .. rst-class:: classref-item-separator @@ -982,6 +1004,7 @@ enum **ModifierCallbackModeProcess**: :ref:`🔗` 骨骼链中的所有 # 在每一个新的帧上自动应用 IK 效果（不是当前的）。 skeleton_ik_node.start() - + # 只在当前帧上应用 IK 效果 skeleton_ik_node.start(true) - + # 停止 IK 效果并重置骨骼上的 bones_global_pose_override skeleton_ik_node.stop() - + # 应用完整的 IK 效果 skeleton_ik_node.set_influence(1.0) - + # 应用一半的 IK 效果 skeleton_ik_node.set_influence(0.5) - + # 应用零 IK 效果（数值为 0.01 或低于 0.01 也会移除 Skeleton 上的 bones_global_pose_override） skeleton_ik_node.set_influence(0.0) @@ -322,6 +322,7 @@ IK 链的目标节点 :ref:`NodePath`\ 。如果有的话，将 停止将 IK 效果应用到每帧的 :ref:`Skeleton3D` 骨骼，并调用 :ref:`Skeleton3D.clear_bones_global_pose_override()` 来移除所有骨骼上的现有覆盖。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2d.rst b/classes/zh_CN/class_skeletonmodification2d.rst index ba95097461..d1de214326 100644 --- a/classes/zh_CN/class_skeletonmodification2d.rst +++ b/classes/zh_CN/class_skeletonmodification2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2D.xml. .. _class_SkeletonModification2D: @@ -224,6 +224,7 @@ SkeletonModification2D 允许你手动设置该修改器的安装状态。这个函数应很少使用，因为该修改器所绑定的 :ref:`SkeletonModificationStack2D` 应该对该修改器进行安装。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dccdik.rst b/classes/zh_CN/class_skeletonmodification2dccdik.rst index acb4b7f2e9..525a51855b 100644 --- a/classes/zh_CN/class_skeletonmodification2dccdik.rst +++ b/classes/zh_CN/class_skeletonmodification2dccdik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DCCDIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DCCDIK.xml. .. _class_SkeletonModification2DCCDIK: @@ -315,6 +315,7 @@ CCDIK 修改中 CCDIK 关节的数量。 设置位于 ``joint_idx`` 的关节是设为从关节旋转，\ ``true``\ ，还是从尖端旋转，\ ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dfabrik.rst b/classes/zh_CN/class_skeletonmodification2dfabrik.rst index 000b81a010..d4d42b9278 100644 --- a/classes/zh_CN/class_skeletonmodification2dfabrik.rst +++ b/classes/zh_CN/class_skeletonmodification2dfabrik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DFABRIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DFABRIK.xml. .. _class_SkeletonModification2DFABRIK: @@ -25,7 +25,7 @@ SkeletonModification2DFABRIK FABRIK 需要先拿到一系列骨骼的位置和长度，这组骨骼通常称作“骨骼链”。它首先会做一次向前处理，将最终的骨骼放置在目标的位置。然后让所有其他骨骼朝尖端骨骼移动，恢复原有的骨骼长度。然后再做一次向后处理，将 FABRIK 链中的根/第一根骨骼放回原点。然后移动所有其他骨骼，恢复原有的骨骼长度。这样就尽可能地让骨骼链抵达了目标，并且所有骨骼之间的长度仍然为正确的长度。 -由于 FABRIK 的工作原理，它通常比 :ref:`SkeletonModification2DCCDIK` 得到的结果更加自然。FABRIK 还支持角度约束，在求解过程中会完全遵守这些约束。 +由于 FABRIK 的工作原理，它通常比 :ref:`SkeletonModification2DCCDIK` 得到的结果更加自然。 \ **注意：**\ FABRIK 修改器具有关节属性 ``fabrik_joints``\ ，里面是存放 FABRIK 链中各个关节数据的数据对象。关节和 :ref:`Bone2D` 是两码事！FABRIK 关节存放的是 FABRIK 所使用的骨骼链中每根 :ref:`Bone2D` 所需的数据。 @@ -214,6 +214,7 @@ FABRIK 修改器的目标节点的 NodePath。FABRIK 链会尝试将骨骼链转 \ **注意：**\ 这个选项仅适用于链中的末端/最终关节。对于所有其他节点，这个选项将被忽略。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2djiggle.rst b/classes/zh_CN/class_skeletonmodification2djiggle.rst index 98faebc006..597a95016d 100644 --- a/classes/zh_CN/class_skeletonmodification2djiggle.rst +++ b/classes/zh_CN/class_skeletonmodification2djiggle.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DJiggle.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DJiggle.xml. .. _class_SkeletonModification2DJiggle: @@ -471,6 +471,7 @@ SkeletonModification2DJiggle 如果为 ``true``\ ，则 Jiggle 修改器将考虑碰撞器，防止它们进入这些碰撞对象。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dlookat.rst b/classes/zh_CN/class_skeletonmodification2dlookat.rst index 5b5a38ada9..8f873f8771 100644 --- a/classes/zh_CN/class_skeletonmodification2dlookat.rst +++ b/classes/zh_CN/class_skeletonmodification2dlookat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DLookAt.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DLookAt.xml. .. _class_SkeletonModification2DLookAt: @@ -253,6 +253,7 @@ SkeletonModification2DLookAt 设置此修改器是否使用约束。为 ``true`` 时，会在求解 LookAt 修改器时应用约束。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dphysicalbones.rst b/classes/zh_CN/class_skeletonmodification2dphysicalbones.rst index df2ed7e2d8..0e80efd189 100644 --- a/classes/zh_CN/class_skeletonmodification2dphysicalbones.rst +++ b/classes/zh_CN/class_skeletonmodification2dphysicalbones.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DPhysicalBones.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DPhysicalBones.xml. .. _class_SkeletonModification2DPhysicalBones: @@ -149,6 +149,7 @@ SkeletonModification2DPhysicalBones 还可以把骨骼名称数组传给这个函数，会导致只有这些名称的 :ref:`PhysicalBone2D` 节点停止模拟。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dstackholder.rst b/classes/zh_CN/class_skeletonmodification2dstackholder.rst index 715d7bf4f6..96966a7cd0 100644 --- a/classes/zh_CN/class_skeletonmodification2dstackholder.rst +++ b/classes/zh_CN/class_skeletonmodification2dstackholder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DStackHolder.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DStackHolder.xml. .. _class_SkeletonModification2DStackHolder: @@ -69,6 +69,7 @@ SkeletonModification2DStackHolder 设置该修改器中存放的 :ref:`SkeletonModificationStack2D`\ 。这个修改器栈会在该修改器执行时执行。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodification2dtwoboneik.rst b/classes/zh_CN/class_skeletonmodification2dtwoboneik.rst index 12b565bacf..7c86cd8462 100644 --- a/classes/zh_CN/class_skeletonmodification2dtwoboneik.rst +++ b/classes/zh_CN/class_skeletonmodification2dtwoboneik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModification2DTwoBoneIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DTwoBoneIK.xml. .. _class_SkeletonModification2DTwoBoneIK: @@ -244,6 +244,7 @@ TwoBoneIK 适用于手臂、腿部，其实任何能够用两根骨头弯向某 设置 TwoBoneIK 修改器中作为第二个骨骼的 :ref:`Bone2D` 节点的索引。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodificationstack2d.rst b/classes/zh_CN/class_skeletonmodificationstack2d.rst index 0c727ec4a0..dc2f66fe49 100644 --- a/classes/zh_CN/class_skeletonmodificationstack2d.rst +++ b/classes/zh_CN/class_skeletonmodificationstack2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModificationStack2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModificationStack2D.xml. .. _class_SkeletonModificationStack2D: @@ -243,6 +243,7 @@ SkeletonModificationStack2D 设置该修改堆栈以便它可以执行。该函数应当由 :ref:`Skeleton2D` 调用，不清楚有什么用就别手动调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonmodifier3d.rst b/classes/zh_CN/class_skeletonmodifier3d.rst index 8411f2aed0..3148fd9571 100644 --- a/classes/zh_CN/class_skeletonmodifier3d.rst +++ b/classes/zh_CN/class_skeletonmodifier3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonModifier3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModifier3D.xml. .. _class_SkeletonModifier3D: @@ -12,7 +12,7 @@ SkeletonModifier3D **继承：** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**派生：** :ref:`LookAtModifier3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` +**派生：** :ref:`BoneConstraint3D`, :ref:`LookAtModifier3D`, :ref:`ModifierBoneTarget3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` 能够修改 Skeleton3D 中骨骼的节点。 @@ -56,11 +56,17 @@ SkeletonModifier3D .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_process_modification`\ (\ ) |virtual| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process_modification`\ (\ ) |virtual| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process_modification_with_delta`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_skeleton_changed`\ (\ old_skeleton\: :ref:`Skeleton3D`, new_skeleton\: :ref:`Skeleton3D`\ ) |virtual| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_validate_bone_names`\ (\ ) |virtual| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -200,7 +206,9 @@ enum **BoneAxis**: :ref:`🔗` |void| **_process_modification**\ (\ ) |virtual| :ref:`🔗` -覆盖该虚拟方法以实现自定义骨架修改器。你应该执行诸如获取 :ref:`Skeleton3D` 的当前姿势并在此处应用姿势之类的操作。 +**已弃用：** Use :ref:`_process_modification_with_delta()` instead. + +覆盖该虚方法可以实现自定义骨架修改器。你应该在这里执行获取 :ref:`Skeleton3D` 的当前姿势、应用姿势之类的操作。 \ :ref:`_process_modification()` 不得将 :ref:`influence` 应用于骨骼姿势，因为 :ref:`Skeleton3D` 会自动将影响应用于修改器设置的所有骨骼姿势。 @@ -208,6 +216,46 @@ enum **BoneAxis**: :ref:`🔗` ---- +.. _class_SkeletonModifier3D_private_method__process_modification_with_delta: + +.. rst-class:: classref-method + +|void| **_process_modification_with_delta**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` + +覆盖该虚方法可以实现自定义骨架修改器。你应该在这里执行获取 :ref:`Skeleton3D` 的当前姿势、应用姿势之类的操作。 + +\ :ref:`_process_modification_with_delta()` 不得将 :ref:`influence` 应用于骨骼姿势，因为 :ref:`Skeleton3D` 会自动将影响应用于修改器设置的所有骨骼姿势。 + +\ ``delta`` 是由父级 :ref:`Skeleton3D` 传入的。另见 :ref:`Skeleton3D.advance()`\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SkeletonModifier3D_private_method__skeleton_changed: + +.. rst-class:: classref-method + +|void| **_skeleton_changed**\ (\ old_skeleton\: :ref:`Skeleton3D`, new_skeleton\: :ref:`Skeleton3D`\ ) |virtual| :ref:`🔗` + +骨架发生改变时调用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SkeletonModifier3D_private_method__validate_bone_names: + +.. rst-class:: classref-method + +|void| **_validate_bone_names**\ (\ ) |virtual| :ref:`🔗` + +在骨骼名称和索引需要验证时调用，例如进入树时或更改骨架时。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SkeletonModifier3D_method_get_skeleton: .. rst-class:: classref-method @@ -217,6 +265,7 @@ enum **BoneAxis**: :ref:`🔗` 存在 :ref:`Skeleton3D` 父节点时将其返回。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonprofile.rst b/classes/zh_CN/class_skeletonprofile.rst index 4d6ddd7d20..b4f2ebebcf 100644 --- a/classes/zh_CN/class_skeletonprofile.rst +++ b/classes/zh_CN/class_skeletonprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfile.xml. .. _class_SkeletonProfile: @@ -507,6 +507,7 @@ enum **TailDirection**: :ref:`🔗` 设置在 ``group_idx`` 处的组的纹理，这将是 :ref:`BoneMap` 编辑器中绘制组的背景图像。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skeletonprofilehumanoid.rst b/classes/zh_CN/class_skeletonprofilehumanoid.rst index 760ae0a3a7..7d85571c34 100644 --- a/classes/zh_CN/class_skeletonprofilehumanoid.rst +++ b/classes/zh_CN/class_skeletonprofilehumanoid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkeletonProfileHumanoid.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfileHumanoid.xml. .. _class_SkeletonProfileHumanoid: @@ -108,6 +108,7 @@ SkeletonProfileHumanoid +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skin.rst b/classes/zh_CN/class_skin.rst index aa602a7c5d..9f5ae999eb 100644 --- a/classes/zh_CN/class_skin.rst +++ b/classes/zh_CN/class_skin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Skin.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skin.xml. .. _class_Skin: @@ -208,6 +208,7 @@ Skin 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_skinreference.rst b/classes/zh_CN/class_skinreference.rst index 039bc07b4c..b452e5793c 100644 --- a/classes/zh_CN/class_skinreference.rst +++ b/classes/zh_CN/class_skinreference.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SkinReference.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkinReference.xml. .. _class_SkinReference: @@ -75,6 +75,7 @@ SkinReference 请注意，如果单个 :ref:`Skin` 由多个 :ref:`Skeleton3D` 节点之间的网格共享，则它可能具有多个 **SkinReference**\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sky.rst b/classes/zh_CN/class_sky.rst index b9bf8372a2..4359c14735 100644 --- a/classes/zh_CN/class_sky.rst +++ b/classes/zh_CN/class_sky.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Sky.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sky.xml. .. _class_Sky: @@ -180,7 +180,7 @@ enum **ProcessMode**: :ref:`🔗` - |void| **set_process_mode**\ (\ value\: :ref:`ProcessMode`\ ) - :ref:`ProcessMode` **get_process_mode**\ (\ ) -设置从天空生成辐射率贴图的方法。辐射率贴图是一种立方体贴图，具有递增的模糊版本的天空，以对应于不同级别的粗糙度。辐射率贴图的计算成本很高。选项见 :ref:`ProcessMode`\ 。 +设置从天空生成辐射率贴图的方法。辐射率贴图是一种立方体贴图，具有递增的模糊版本的天空，以对应于不同级别的粗糙度。辐射率贴图的计算成本很高。 .. rst-class:: classref-item-separator @@ -199,8 +199,6 @@ enum **ProcessMode**: :ref:`🔗` 该 **Sky** 的辐射率贴图大小。辐射率贴图尺寸越大，来自 **Sky** 的照明就越详细。 -取值见 :ref:`RadianceSize` 常量。 - \ **注意：**\ 某些硬件在使用较高的辐射率大小，尤其是 :ref:`RADIANCE_SIZE_512` 及以上时，会遇到问题。请仅在高端硬件上使用如此高的值。 .. rst-class:: classref-item-separator @@ -221,6 +219,7 @@ enum **ProcessMode**: :ref:`🔗` 用于绘制该背景的 :ref:`Material`\ 。可以是 :ref:`PanoramaSkyMaterial`\ 、\ :ref:`ProceduralSkyMaterial`\ 、\ :ref:`PhysicalSkyMaterial`\ ，如果你想使用自定义着色器也可以是 :ref:`ShaderMaterial`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_slider.rst b/classes/zh_CN/class_slider.rst index 1fcd8e14da..4dba50a569 100644 --- a/classes/zh_CN/class_slider.rst +++ b/classes/zh_CN/class_slider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Slider.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Slider.xml. .. _class_Slider: @@ -31,19 +31,21 @@ Slider .. table:: :widths: auto - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editable` | ``true`` | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scrollable` | ``true`` | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`int` | :ref:`tick_count` | ``0`` | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ - | :ref:`bool` | :ref:`ticks_on_borders` | ``false`` | - +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editable` | ``true`` | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scrollable` | ``true`` | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`tick_count` | ``0`` | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ticks_on_borders` | ``false`` | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`TickPosition` | :ref:`ticks_position` | ``0`` | + +-----------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -58,6 +60,8 @@ Slider +-----------------------------------+--------------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`grabber_offset` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`tick_offset` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ | :ref:`Texture2D` | :ref:`grabber` | | +-----------------------------------+--------------------------------------------------------------------------------+-------+ | :ref:`Texture2D` | :ref:`grabber_disabled` | | @@ -108,6 +112,53 @@ Slider .. rst-class:: classref-descriptions-group +枚举 +---- + +.. _enum_Slider_TickPosition: + +.. rst-class:: classref-enumeration + +enum **TickPosition**: :ref:`🔗` + +.. _class_Slider_constant_TICK_POSITION_BOTTOM_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TickPosition` **TICK_POSITION_BOTTOM_RIGHT** = ``0`` + +将刻度放置在 :ref:`HSlider` 的底部、\ :ref:`VSlider` 的右侧。 + +.. _class_Slider_constant_TICK_POSITION_TOP_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TickPosition` **TICK_POSITION_TOP_LEFT** = ``1`` + +将刻度放置在 :ref:`HSlider` 的顶部、\ :ref:`VSlider` 的左侧。 + +.. _class_Slider_constant_TICK_POSITION_BOTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`TickPosition` **TICK_POSITION_BOTH** = ``2`` + +在滑杆的两侧放置刻度。 + +.. _class_Slider_constant_TICK_POSITION_CENTER: + +.. rst-class:: classref-enumeration-constant + +:ref:`TickPosition` **TICK_POSITION_CENTER** = ``3`` + +在滑杆的中间放置刻度。 + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + 属性说明 -------- @@ -175,6 +226,23 @@ Slider 如果为 ``true``\ ，则滑杆将显示最小值和最大值的刻度。 +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_property_ticks_position: + +.. rst-class:: classref-property + +:ref:`TickPosition` **ticks_position** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_ticks_position**\ (\ value\: :ref:`TickPosition`\ ) +- :ref:`TickPosition` **get_ticks_position**\ (\ ) + +设置刻度的位置。详见 :ref:`TickPosition`\ 。 + .. rst-class:: classref-section-separator ---- @@ -208,6 +276,18 @@ Slider ---- +.. _class_Slider_theme_constant_tick_offset: + +.. rst-class:: classref-themeproperty + +:ref:`int` **tick_offset** = ``0`` :ref:`🔗` + +刻度的垂直或水平偏移量。顶部和左侧刻度的偏移量是反的。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Slider_theme_icon_grabber: .. rst-class:: classref-themeproperty @@ -289,6 +369,7 @@ Slider 整个滑杆的背景。影响 :ref:`grabber_area` 的高度或宽度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sliderjoint3d.rst b/classes/zh_CN/class_sliderjoint3d.rst index 8fcda91e6d..181c55e041 100644 --- a/classes/zh_CN/class_sliderjoint3d.rst +++ b/classes/zh_CN/class_sliderjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SliderJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SliderJoint3D.xml. .. _class_SliderJoint3D: @@ -688,7 +688,7 @@ enum **Param**: :ref:`🔗` :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` -返回给定参数的取值（见 :ref:`Param` 常量）。 +返回给定参数的值。 .. rst-class:: classref-item-separator @@ -700,9 +700,10 @@ enum **Param**: :ref:`🔗` |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` -将 ``value`` 赋值给指定的参数（见 :ref:`Param` 常量）。 +将 ``value`` 赋值给指定的参数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_softbody3d.rst b/classes/zh_CN/class_softbody3d.rst index 05d2fb7170..d8d0ba3f26 100644 --- a/classes/zh_CN/class_softbody3d.rst +++ b/classes/zh_CN/class_softbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SoftBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SoftBody3D.xml. .. _class_SoftBody3D: @@ -23,7 +23,7 @@ SoftBody3D 此外，\ **SoftBody3D** 受 :ref:`Area3D` 中定义的风力影响（参见 :ref:`Area3D.wind_source_path`\ 、\ :ref:`Area3D.wind_force_magnitude` 和 :ref:`Area3D.wind_attenuation_factor`\ ）。 -\ **注意：**\ **SoftBody3D** 中有许多已知的问题。因此，不建议用于可能影响游戏玩法的东西上（例如蹦床）。 +\ **注意：**\ 使用 **SoftBody3D** 时建议使用 Jolt Physics，不要使用默认的 GodotPhysics3D，因为 Jolt Physics 的柔体实现更快更可靠。你可以使用 :ref:`ProjectSettings.physics/3d/physics_engine` 项目设置来切换物理引擎。 .. rst-class:: classref-introduction-group @@ -59,6 +59,8 @@ SoftBody3D +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`ray_pickable` | ``true`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`shrinking_factor` | ``0.0`` | + +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`simulation_precision` | ``5`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`total_mass` | ``1.0`` | @@ -75,6 +77,14 @@ SoftBody3D +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector3`\ ) | + +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | + +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_force`\ (\ point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) | + +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_impulse`\ (\ point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) | + +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`PhysicsBody3D`\] | :ref:`get_collision_exceptions`\ (\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | @@ -204,7 +214,7 @@ enum **DisableMode**: :ref:`🔗` - |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) - :ref:`DisableMode` **get_disable_mode**\ (\ ) -定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。不同模式详见 :ref:`DisableMode`\ 。 +定义 :ref:`Node.process_mode` 为 :ref:`Node.PROCESS_MODE_DISABLED` 时的物理行为。 .. rst-class:: classref-item-separator @@ -297,6 +307,25 @@ enum **DisableMode**: :ref:`🔗` ---- +.. _class_SoftBody3D_property_shrinking_factor: + +.. rst-class:: classref-property + +:ref:`float` **shrinking_factor** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_shrinking_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_shrinking_factor**\ (\ ) + +缩放 **SoftBody3D** 的边约束的剩余长度。正值会收缩网格，负值会扩展网格。例如，值为 ``0.1`` 会将网格的边缩短 10%，而 ``-0.1`` 则会将边扩展 10%。 + +\ **注意：**\ :ref:`shrinking_factor` 最适用于存在钉固点的表面网格。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SoftBody3D_property_simulation_precision: .. rst-class:: classref-property @@ -348,6 +377,58 @@ enum **DisableMode**: :ref:`🔗` ---- +.. _class_SoftBody3D_method_apply_central_force: + +.. rst-class:: classref-method + +|void| **apply_central_force**\ (\ force\: :ref:`Vector3`\ ) :ref:`🔗` + +将力分配并施加到所有点上。力是时间相关的，应在每次物理更新时施加。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SoftBody3D_method_apply_central_impulse: + +.. rst-class:: classref-method + +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` + +将冲量分配并施加到所有点上。 + +冲量与时间无关！如果每帧都施加冲量会得到与帧率相关的力。因此只应在模拟一次性冲击时使用（否则请使用“_force”函数）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SoftBody3D_method_apply_force: + +.. rst-class:: classref-method + +|void| **apply_force**\ (\ point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) :ref:`🔗` + +将力施加到某个点上。力是时间相关的，应在每次物理更新时施加。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SoftBody3D_method_apply_impulse: + +.. rst-class:: classref-method + +|void| **apply_impulse**\ (\ point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` + +将冲量施加到某个点上。 + +冲量与时间无关！如果每帧都施加冲量会得到与帧率相关的力。因此只应在模拟一次性冲击时使用（否则请使用“_force”函数）。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SoftBody3D_method_get_collision_exceptions: .. rst-class:: classref-method @@ -465,6 +546,7 @@ enum **DisableMode**: :ref:`🔗` 设置表面顶点的固定状态。当设置为 ``true`` 时，可选的 ``attachment_path`` 可以定义一个 :ref:`Node3D`\ ，该固定顶点将被附加到该节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_spheremesh.rst b/classes/zh_CN/class_spheremesh.rst index cc713f33ba..e6901e0599 100644 --- a/classes/zh_CN/class_spheremesh.rst +++ b/classes/zh_CN/class_spheremesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SphereMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereMesh.xml. .. _class_SphereMesh: @@ -134,6 +134,7 @@ SphereMesh 沿着球体高度的段数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sphereoccluder3d.rst b/classes/zh_CN/class_sphereoccluder3d.rst index 6c7caf7de2..ca409049d3 100644 --- a/classes/zh_CN/class_sphereoccluder3d.rst +++ b/classes/zh_CN/class_sphereoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SphereOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereOccluder3D.xml. .. _class_SphereOccluder3D: @@ -65,6 +65,7 @@ SphereOccluder3D 球体半径，使用 3D 单位。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sphereshape3d.rst b/classes/zh_CN/class_sphereshape3d.rst index aa1b6d5a2c..34bdc6b31b 100644 --- a/classes/zh_CN/class_sphereshape3d.rst +++ b/classes/zh_CN/class_sphereshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SphereShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereShape3D.xml. .. _class_SphereShape3D: @@ -65,6 +65,7 @@ SphereShape3D 球体的半径。形状的直径是半径的两倍。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_spinbox.rst b/classes/zh_CN/class_spinbox.rst index 38e7ff9f6d..c3c140b705 100644 --- a/classes/zh_CN/class_spinbox.rst +++ b/classes/zh_CN/class_spinbox.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpinBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpinBox.xml. .. _class_SpinBox: @@ -22,7 +22,9 @@ SpinBox 描述 ---- -**SpinBox** 是一种用于输入数值的文本框，允许输入整数和浮点数。 +**SpinBox** 是一种用于输入数值的文本框，允许输入整数和浮点数。\ **SpinBox** 还提供了上下按钮，点击后会对取值进行上调和下调。取值还可以通过在 **SpinBox** 的箭头上上下拖动鼠标进行调整。 + +另外还可以输入数学表达式。用户在编辑 **SpinBox** 的文本框时按下 :kbd:`Enter` 就会进行表达式求值。对表达式的解析和求值是使用 :ref:`Expression` 类实现的。表达式的结果会设为 **SpinBox** 的取值。有效表达式的示例： ``5 + 2 * 3``\ 、\ ``pow(2, 4)``\ 、\ ``PI + sin(0.5)``\ 。表达式是大小写敏感的。 \ **示例：**\ 创建 **SpinBox**\ ，禁用其上下文菜单，并将文本设置为右对齐。 @@ -206,7 +208,9 @@ SpinBox - |void| **set_custom_arrow_step**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_custom_arrow_step**\ (\ ) -如果不是 ``0``\ ，则在与 **SpinBox** 的箭头按钮交互时，\ :ref:`Range.value` 将始终四舍五入为 :ref:`custom_arrow_step` 的倍数。 +如果不是 ``0``\ ，则设置与 **SpinBox** 的箭头按钮交互时的步长。 + +\ **注意：**\ :ref:`Range.value` 仍然会舍入到 :ref:`Range.step` 的倍数。 .. rst-class:: classref-item-separator @@ -291,7 +295,9 @@ SpinBox - |void| **set_update_on_text_changed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_update_on_text_changed**\ (\ ) -当 :ref:`LineEdit` 的文本\ *发生变化*\ 而不是\ *被提交*\ 时，设置这个 **SpinBox** 的 :ref:`Range` 的值。见 :ref:`LineEdit.text_changed` 和 :ref:`LineEdit.text_submitted`\ 。 +设置该 **SpinBox** 的 :ref:`Range` 值在 :ref:`LineEdit` 文本\ *发生改变时*\ 更新，不再在\ *提交时*\ 更新。见 :ref:`LineEdit.text_changed` 和 :ref:`LineEdit.text_submitted`\ 。 + +\ **注意：**\ 如果设置为 ``true``\ ，会影响在 **SpinBox** 中输入数学表达式。\ **SpinBox** 会在你打字时尝试对表达式求值，因此，部分符号会因为表达式求值而被立即移除，例如末尾的 ``+`` 号。 .. rst-class:: classref-section-separator @@ -308,7 +314,7 @@ SpinBox |void| **apply**\ (\ ) :ref:`🔗` -应用此 **SpinBox** 的当前值。 +应用 **SpinBox** 的当前值。等价于在 **SpinBox** 所使用的 :ref:`LineEdit` 中进行编辑时按下 :kbd:`Enter` 键。会导致发出 :ref:`LineEdit.text_submitted`\ 、对当前所包含的表达式进行求值。 .. rst-class:: classref-item-separator @@ -579,7 +585,7 @@ SpinBox :ref:`Texture2D` **updown** :ref:`🔗` -代表上下按钮图标的单个纹理。该纹理显示在按钮中间，交互式不会改变。建议使用单独的 :ref:`up` 和 :ref:`down` 图像，可用性更佳。也可以将其当作两个按钮之间的额外装饰。 +代表上下按钮图标的单个纹理。该纹理显示在按钮中间，交互式不会改变。分配有效的图标后会代替 :ref:`up` 和 :ref:`down`\ 。 .. rst-class:: classref-item-separator @@ -702,6 +708,7 @@ SpinBox 上下按钮之间的间隔区域内绘制的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_splitcontainer.rst b/classes/zh_CN/class_splitcontainer.rst index 3958e3d974..e158adf410 100644 --- a/classes/zh_CN/class_splitcontainer.rst +++ b/classes/zh_CN/class_splitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SplitContainer.xml. .. _class_SplitContainer: @@ -55,6 +55,8 @@ SplitContainer +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`split_offset` | ``0`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`touch_dragger_enabled` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`vertical` | ``false`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ @@ -80,21 +82,33 @@ SplitContainer .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`autohide` | ``1`` | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`separation` | ``12`` | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`Texture2D` | :ref:`grabber` | | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`Texture2D` | :ref:`h_grabber` | | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`Texture2D` | :ref:`v_grabber` | | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ - | :ref:`StyleBox` | :ref:`split_bar_background` | | - +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`touch_dragger_color` | ``Color(1, 1, 1, 0.3)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`touch_dragger_hover_color` | ``Color(1, 1, 1, 0.6)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`touch_dragger_pressed_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`autohide` | ``1`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`separation` | ``12`` | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`grabber` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`h_grabber` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`h_touch_dragger` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`touch_dragger` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`v_grabber` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`v_touch_dragger` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`StyleBox` | :ref:`split_bar_background` | | + +-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-section-separator @@ -287,7 +301,7 @@ enum **DraggerVisibility**: :ref:`🔗` - |void| **set_dragger_visibility**\ (\ value\: :ref:`DraggerVisibility`\ ) - :ref:`DraggerVisibility` **get_dragger_visibility**\ (\ ) -决定拖动器是否可见。详见 :ref:`DraggerVisibility`\ 。该属性无法决定拖动器是否启用，这一需求请使用 :ref:`dragging_enabled`\ 。 +决定拖动器是否可见。该属性无法决定拖动器是否启用，这一需求请使用 :ref:`dragging_enabled`\ 。 .. rst-class:: classref-item-separator @@ -327,6 +341,23 @@ enum **DraggerVisibility**: :ref:`🔗` ---- +.. _class_SplitContainer_property_touch_dragger_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **touch_dragger_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_touch_dragger_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_touch_dragger_enabled**\ (\ ) + +如果为 ``true``\ ，则会启用适合触控的拖动手柄，方便在小尺寸屏幕上使用。与标准抓取器不同，这个拖动手柄与 **SplitContainer** 的子节点存在重叠，不会影响它们的最小间隔。启用该选项时不再绘制标准抓取器。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SplitContainer_property_vertical: .. rst-class:: classref-property @@ -388,6 +419,42 @@ enum **DraggerVisibility**: :ref:`🔗` 主题属性说明 ------------ +.. _class_SplitContainer_theme_color_touch_dragger_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **touch_dragger_color** = ``Color(1, 1, 1, 0.3)`` :ref:`🔗` + +触摸拖动器的颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplitContainer_theme_color_touch_dragger_hover_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **touch_dragger_hover_color** = ``Color(1, 1, 1, 0.6)`` :ref:`🔗` + +触摸拖动器悬停状态的颜色。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplitContainer_theme_color_touch_dragger_pressed_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **touch_dragger_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +触摸拖动器按下状态的颜色。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SplitContainer_theme_constant_autohide: .. rst-class:: classref-themeproperty @@ -432,7 +499,7 @@ enum **DraggerVisibility**: :ref:`🔗` :ref:`Texture2D` **grabber** :ref:`🔗` -在中间区域绘制的抓取图标。 +用于在中间区域绘制的拖动器的图标。仅在 :ref:`HSplitContainer` 和 :ref:`VSplitContainer` 中使用。对于 **SplitContainer**\ ，见 :ref:`h_grabber` 和 :ref:`v_grabber`\ 。 .. rst-class:: classref-item-separator @@ -450,6 +517,30 @@ enum **DraggerVisibility**: :ref:`🔗` ---- +.. _class_SplitContainer_theme_icon_h_touch_dragger: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **h_touch_dragger** :ref:`🔗` + +:ref:`touch_dragger_enabled` 为 ``true`` 且 :ref:`vertical` 为 ``false`` 时拖拽手柄所使用的图标。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplitContainer_theme_icon_touch_dragger: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **touch_dragger** :ref:`🔗` + +:ref:`touch_dragger_enabled` 为 ``true`` 时用于拖放手柄的图标。仅在 :ref:`HSplitContainer` 和 :ref:`VSplitContainer` 中使用。对于 **SplitContainer**\ ，见 :ref:`h_touch_dragger` 和 :ref:`v_touch_dragger`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SplitContainer_theme_icon_v_grabber: .. rst-class:: classref-themeproperty @@ -462,6 +553,18 @@ enum **DraggerVisibility**: :ref:`🔗` ---- +.. _class_SplitContainer_theme_icon_v_touch_dragger: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **v_touch_dragger** :ref:`🔗` + +:ref:`touch_dragger_enabled` 为 ``true`` 且 :ref:`vertical` 为 ``true`` 时拖拽手柄所使用的图标。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SplitContainer_theme_style_split_bar_background: .. rst-class:: classref-themeproperty @@ -471,6 +574,7 @@ enum **DraggerVisibility**: :ref:`🔗` 决定拆分条厚度大于零时的背景。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_spotlight3d.rst b/classes/zh_CN/class_spotlight3d.rst index 0ca6d80bcb..1a9dace851 100644 --- a/classes/zh_CN/class_spotlight3d.rst +++ b/classes/zh_CN/class_spotlight3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpotLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpotLight3D.xml. .. _class_SpotLight3D: @@ -21,6 +21,8 @@ SpotLight3D 聚光灯是一种 :ref:`Light3D` 节点，向指定的方向发出圆锥形的灯光。光线会随距离增大而衰减。衰减可以通过修改 :ref:`Light3D` 的能量、半径、衰减参数进行控制。 +灯光的发射方向是该节点全局基的 -Z 方向。如果光源未旋转，则灯光向前发射，照亮 3D 模型的正面（见 :ref:`Vector3.FORWARD` 和 :ref:`Vector3.MODEL_FRONT`\ ）。 + \ **注意：**\ 使用 Mobile 渲染方法时，单个网格资源只能用到 8 盏聚光灯。尝试对单个网格资源使用超过 8 盏聚光灯会导致聚光灯在相机移动时产生闪烁。使用 Compatibility 渲染方法时，单个网格资源默认只能用到 8 盏聚光灯，但可以通过调整 :ref:`ProjectSettings.rendering/limits/opengl/max_lights_per_object` 增加。 \ **注意：**\ 使用 Mobile 或 Compatibility 渲染方法时，聚光灯只能影响可见 AABB 与灯光 AABB 相交的网格。如果使用了着色器将网格进行了变形，超出了 AABB 的范围，则必须将该网格的 :ref:`GeometryInstance3D.extra_cull_margin` 增大。否则灯光在该网格上可能不可见。 @@ -80,9 +82,9 @@ SpotLight3D - |void| **set_param**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ ) -聚光灯的角度，单位为度。 +聚光灯的夹角，单位为度。这是夹角的半径，即从 -Z 轴锥形中心到锥形边缘的角度。默认角度半径为 45 度，对应的角度直径为 90 度。 -\ **注意：**\ :ref:`spot_angle` 不受 :ref:`Node3D.scale` 的影响（无论是该灯光的缩放还是其父节点的缩放）。 +\ **注意：**\ :ref:`spot_angle` 不受 :ref:`Node3D.scale` 的影响（无论是灯光本身还是父级节点的缩放）。 .. rst-class:: classref-item-separator @@ -144,6 +146,7 @@ SpotLight3D \ **注意：**\ :ref:`spot_angle` 不受 :ref:`Node3D.scale` 的影响（无论是该灯光的缩放还是其父节点的缩放）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springarm3d.rst b/classes/zh_CN/class_springarm3d.rst index d99300326b..267957381c 100644 --- a/classes/zh_CN/class_springarm3d.rst +++ b/classes/zh_CN/class_springarm3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringArm3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringArm3D.xml. .. _class_SpringArm3D: @@ -199,6 +199,7 @@ SpringArm3D 的最大范围。这用作内部使用的射线和形状投射的 从碰撞检测排除 :ref:`PhysicsBody3D` 对象的列表中移除给定的 :ref:`RID`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springbonecollision3d.rst b/classes/zh_CN/class_springbonecollision3d.rst index 6c0ebf7119..ebf4cbbc88 100644 --- a/classes/zh_CN/class_springbonecollision3d.rst +++ b/classes/zh_CN/class_springbonecollision3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringBoneCollision3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringBoneCollision3D.xml. .. _class_SpringBoneCollision3D: @@ -150,6 +150,7 @@ SpringBoneCollision3D 获取父级 :ref:`SpringBoneSimulator3D` 的父级 :ref:`Skeleton3D` 节点。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springbonecollisioncapsule3d.rst b/classes/zh_CN/class_springbonecollisioncapsule3d.rst index 123e66a85a..c2abfd3e86 100644 --- a/classes/zh_CN/class_springbonecollisioncapsule3d.rst +++ b/classes/zh_CN/class_springbonecollisioncapsule3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringBoneCollisionCapsule3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringBoneCollisionCapsule3D.xml. .. _class_SpringBoneCollisionCapsule3D: @@ -29,13 +29,15 @@ SpringBoneCollisionCapsule3D .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`height` | ``0.5`` | - +---------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`inside` | ``false`` | - +---------------------------+-------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`radius` | ``0.1`` | - +---------------------------+-------------------------------------------------------------------+-----------+ + +---------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`height` | ``0.5`` | + +---------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`inside` | ``false`` | + +---------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`mid_height` | | + +---------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`radius` | ``0.1`` | + +---------------------------+---------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -57,7 +59,9 @@ SpringBoneCollisionCapsule3D - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -胶囊体的高度。 +胶囊体的总高度，包括半球。 + +\ **注意：**\ 胶囊体的 :ref:`height` 必须至少为其 :ref:`radius` 的两倍。否则，胶囊体将变为球体。如果 :ref:`height` 小于 :ref:`radius` 的两倍，则属性将调整为有效值。 .. rst-class:: classref-item-separator @@ -80,6 +84,23 @@ SpringBoneCollisionCapsule3D ---- +.. _class_SpringBoneCollisionCapsule3D_property_mid_height: + +.. rst-class:: classref-property + +:ref:`float` **mid_height** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mid_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mid_height**\ (\ ) + +胶囊的高度，不包括两个半球。这是胶囊中间圆柱部分的高度，即两个半球球心之间的距离。这是对 :ref:`height` 的封装。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneCollisionCapsule3D_property_radius: .. rst-class:: classref-property @@ -93,7 +114,10 @@ SpringBoneCollisionCapsule3D 胶囊体的半径。 +\ **注意：**\ 胶囊体的 :ref:`radius` 不能大于其 :ref:`height` 的一半。否则，胶囊体将变为球体。如果 :ref:`radius` 大于 :ref:`height` 的一半，则属性将调整为有效值。 + .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springbonecollisionplane3d.rst b/classes/zh_CN/class_springbonecollisionplane3d.rst index 52300ed6bf..c5364763e4 100644 --- a/classes/zh_CN/class_springbonecollisionplane3d.rst +++ b/classes/zh_CN/class_springbonecollisionplane3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringBoneCollisionPlane3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringBoneCollisionPlane3D.xml. .. _class_SpringBoneCollisionPlane3D: @@ -22,6 +22,7 @@ SpringBoneCollisionPlane3D 与 :ref:`SpringBoneSimulator3D` 交互的无限延伸的平面碰撞，是无穷大的 XZ 平面，+Y 方向为法线。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springbonecollisionsphere3d.rst b/classes/zh_CN/class_springbonecollisionsphere3d.rst index 5c9bfcf5f9..4904cc7414 100644 --- a/classes/zh_CN/class_springbonecollisionsphere3d.rst +++ b/classes/zh_CN/class_springbonecollisionsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringBoneCollisionSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringBoneCollisionSphere3D.xml. .. _class_SpringBoneCollisionSphere3D: @@ -75,6 +75,7 @@ SpringBoneCollisionSphere3D 球体的半径。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_springbonesimulator3d.rst b/classes/zh_CN/class_springbonesimulator3d.rst index 1402447ed0..5539b6e682 100644 --- a/classes/zh_CN/class_springbonesimulator3d.rst +++ b/classes/zh_CN/class_springbonesimulator3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpringBoneSimulator3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringBoneSimulator3D.xml. .. _class_SpringBoneSimulator3D: @@ -41,9 +41,11 @@ SpringBoneSimulator3D .. table:: :widths: auto - +-----------------------+--------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`setting_count` | ``0`` | - +-----------------------+--------------------------------------------------------------------------+-------+ + +-------------------------------+----------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -112,6 +114,8 @@ SpringBoneSimulator3D +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RotationAxis` | :ref:`get_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_radius`\ (\ index\: :ref:`int`\ ) |const| | @@ -124,6 +128,8 @@ SpringBoneSimulator3D +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RotationAxis` | :ref:`get_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_rotation_axis_vector`\ (\ index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_stiffness`\ (\ index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`get_stiffness_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | @@ -184,6 +190,8 @@ SpringBoneSimulator3D +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`, stiffness\: :ref:`float`\ ) | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_radius`\ (\ index\: :ref:`int`, radius\: :ref:`float`\ ) | @@ -196,6 +204,8 @@ SpringBoneSimulator3D +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_rotation_axis_vector`\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_stiffness`\ (\ index\: :ref:`int`, stiffness\: :ref:`float`\ ) | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_stiffness_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | @@ -352,6 +362,14 @@ enum **RotationAxis**: :ref:`🔗` 枚举值，表示无约束的旋转。 +.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_CUSTOM** = ``4`` + +枚举值，表示可选的旋转轴。另见 :ref:`set_joint_rotation_axis_vector()`\ 。 + .. rst-class:: classref-section-separator ---- @@ -361,6 +379,25 @@ enum **RotationAxis**: :ref:`🔗` 属性说明 -------- +.. _class_SpringBoneSimulator3D_property_external_force: + +.. rst-class:: classref-property + +:ref:`Vector3` **external_force** = ``Vector3(0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_external_force**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_external_force**\ (\ ) + +始终作用于骨骼的恒定力。当父级 :ref:`Skeleton3D` 以相反方向以此速度移动时，该力等于其结果。 + +对于风和反重力等效果非常有用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_property_setting_count: .. rst-class:: classref-property @@ -731,6 +768,20 @@ enum **RotationAxis**: :ref:`🔗` ---- +.. _class_SpringBoneSimulator3D_method_get_joint_rotation_axis_vector: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_joint_rotation_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +返回骨骼链中指定关节的旋转轴向量。该向量代表的是关节旋转时所围绕的转轴。根据为关节设置的旋转轴决定。 + +如果 :ref:`get_joint_rotation_axis()` 为 :ref:`ROTATION_AXIS_ALL`\ ，则该方法返回 ``Vector3(0, 0, 0)``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_method_get_joint_stiffness: .. rst-class:: classref-method @@ -803,6 +854,20 @@ enum **RotationAxis**: :ref:`🔗` ---- +.. _class_SpringBoneSimulator3D_method_get_rotation_axis_vector: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_rotation_axis_vector**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回骨骼链的旋转轴向量。该向量表示骨骼链围绕哪个轴旋转，是根据为骨骼链设置的旋转轴确定的。 + +如果 :ref:`get_rotation_axis()` 为 :ref:`ROTATION_AXIS_ALL`\ ，则该方法返回 ``Vector3(0, 0, 0)``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_method_get_stiffness: .. rst-class:: classref-method @@ -975,9 +1040,9 @@ enum **RotationAxis**: :ref:`🔗` |void| **set_enable_all_child_collisions**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` -如果将 ``enabled`` 设置为 ``true``\ ，则所有子级 :ref:`SpringBoneCollision3D` 都会发生碰撞，\ :ref:`set_exclude_collision_path()` 在设置中的 ``index`` 处启用作为排除列表。 +如果 ``enabled`` 为 ``true``\ ，则所有子级 :ref:`SpringBoneCollision3D` 都会发生碰撞，\ :ref:`set_exclude_collision_path()` 在设置中的 ``index`` 处启用作为排除列表。 -如果将 ``enabled`` 设置为 ``false``\ ，则需要手动使用 :ref:`set_collision_path()` 注册所有有效的碰撞。 +如果 ``enabled`` 为 ``false``\ ，则需要手动使用 :ref:`set_collision_path()` 注册所有有效的碰撞。 .. rst-class:: classref-item-separator @@ -1181,7 +1246,27 @@ enum **RotationAxis**: :ref:`🔗` |void| **set_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` -当 :ref:`is_config_individual()` 为 ``true`` 时，设置骨骼链关节列表中 ``joint`` 关节的旋转轴。 +设置当 :ref:`is_config_individual()` 为 ``true`` 时，在骨骼链的关节列表中 ``joint`` 的旋转轴。 + +旋转轴基于 :ref:`Skeleton3D.get_bone_rest()` 的空间，如果 ``axis`` 为 :ref:`ROTATION_AXIS_CUSTOM`\ ，则可以指定任何轴。 + +\ **注意：**\ 旋转轴和前向向量不应共线，否则可能造成意外旋转，因为 **SpringBoneSimulator3D** 不考虑扭转力。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SpringBoneSimulator3D_method_set_joint_rotation_axis_vector: + +.. rst-class:: classref-method + +|void| **set_joint_rotation_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) :ref:`🔗` + +为骨骼链中指定的关节设置旋转轴向量。 + +该向量经过内部处理后会被归一化，表示骨骼链围绕哪个轴旋转。 + +如果向量长度为 ``0``\ ，则被视为与 :ref:`ROTATION_AXIS_ALL` 同义。 .. rst-class:: classref-item-separator @@ -1255,11 +1340,27 @@ enum **RotationAxis**: :ref:`🔗` |void| **set_rotation_axis**\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` -设置骨骼链的旋转轴。如果设置了特定的轴，效果就会像铰链关节一样。 +设置骨骼链的旋转轴。如果设置为特定的轴，行为就会像铰链关节。该值会缓存到关节列表中的每个关节设置中。 -该值会缓存到关节列表中的每个关节的设置中。 +旋转轴基于 :ref:`Skeleton3D.get_bone_rest()` 的空间，如果 ``axis`` 为 :ref:`ROTATION_AXIS_CUSTOM`\ ，则可以指定任何轴。 -\ **注意：**\ 由于 **SpringBoneSimulator3D** 不考虑扭转力，旋转轴和前进向量不应共线，以避免意外旋转。 +\ **注意：**\ 旋转轴向量和前向向量不应共线，否则可能造成意外旋转，因为 **SpringBoneSimulator3D** 不考虑扭转力。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_SpringBoneSimulator3D_method_set_rotation_axis_vector: + +.. rst-class:: classref-method + +|void| **set_rotation_axis_vector**\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) :ref:`🔗` + +设置骨骼链的旋转轴向量。该值会缓存到关节列表中的每个关节设置中。 + +该向量经过内部处理后会被归一化，表示骨骼链围绕哪个轴旋转。 + +如果向量长度为 ``0``\ ，则被视为与 :ref:`ROTATION_AXIS_ALL` 同义。 .. rst-class:: classref-item-separator @@ -1290,6 +1391,7 @@ enum **RotationAxis**: :ref:`🔗` 设置骨骼链的刚度力阻尼曲线。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sprite2d.rst b/classes/zh_CN/class_sprite2d.rst index 15c0261deb..0ce96e3fb7 100644 --- a/classes/zh_CN/class_sprite2d.rst +++ b/classes/zh_CN/class_sprite2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Sprite2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sprite2D.xml. .. _class_Sprite2D: @@ -229,7 +229,9 @@ Sprite2D - |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_offset**\ (\ ) -纹理的绘图偏移量。 +纹理绘制偏移。 + +\ **注意：**\ 在 Sprite2D 中增大 :ref:`offset`.y 会让精灵在屏幕上向下移动（即 +Y 朝下）。 .. rst-class:: classref-item-separator @@ -246,7 +248,9 @@ Sprite2D - |void| **set_region_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_region_enabled**\ (\ ) -如果为 ``true``\ ，则从较大的图集纹理中剪切纹理。见 :ref:`region_rect`\ 。 +If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. + +\ **Note:** When using a custom :ref:`Shader` on a **Sprite2D**, the ``UV`` shader built-in will refer to the entire texture space. Use the ``REGION_RECT`` built-in to get the currently visible region defined in :ref:`region_rect` instead. See :doc:`CanvasItem shaders <../tutorials/shaders/shader_reference/canvas_item_shader>` for details. .. rst-class:: classref-item-separator @@ -378,6 +382,7 @@ Sprite2D \ **注意：**\ 如果精灵的纹理为 ``null`` 或者给定的位置无效，它也会返回 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_sprite3d.rst b/classes/zh_CN/class_sprite3d.rst index d538248ada..a6e2645862 100644 --- a/classes/zh_CN/class_sprite3d.rst +++ b/classes/zh_CN/class_sprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Sprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sprite3D.xml. .. _class_Sprite3D: @@ -199,6 +199,7 @@ Sprite3D 精灵表中的行数。该属性发生变化时会对 :ref:`frame` 进行调整，在视觉上维持相同的帧（同一行、同一列）。如果无法维持，则会将 :ref:`frame` 重置为 ``0``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_spritebase3d.rst b/classes/zh_CN/class_spritebase3d.rst index 6cd29502ce..7f5e2b4181 100644 --- a/classes/zh_CN/class_spritebase3d.rst +++ b/classes/zh_CN/class_spritebase3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpriteBase3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpriteBase3D.xml. .. _class_SpriteBase3D: @@ -233,7 +233,7 @@ enum **AlphaCutMode**: :ref:`🔗` - |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) - :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) -要应用的 Alpha 抗锯齿类型。见 :ref:`AlphaAntiAliasing`\ 。 +要应用的 Alpha 抗锯齿类型。 .. rst-class:: classref-item-separator @@ -250,7 +250,7 @@ enum **AlphaCutMode**: :ref:`🔗` - |void| **set_alpha_cut_mode**\ (\ value\: :ref:`AlphaCutMode`\ ) - :ref:`AlphaCutMode` **get_alpha_cut_mode**\ (\ ) -该精灵的 Alpha 裁剪模式。可能的取值见 :ref:`AlphaCutMode`\ 。 +精灵所使用的 Alpha 剪切模式。 .. rst-class:: classref-item-separator @@ -318,7 +318,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) - :ref:`BillboardMode` **get_billboard_mode**\ (\ ) -精灵的公告板模式。可能的取值见 :ref:`BillboardMode`\ 。 +精灵的公告板模式。 \ **注意：**\ 如果启用了公告板并且材质能够投射阴影，那么渲染阴影时公告板面向的是\ **场景中**\ 的相机。如果场景中存在多个相机，则无法确定阴影，会导致未定义的行为。详见 `GitHub Pull Request #72638 `__\ 。 @@ -371,7 +371,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| -如果为 ``true``\ ，则无论距离远近，标签都以相同的尺寸呈现。 +如果为 ``true``\ ，则纹理始终以相同的大小渲染，忽略距离。纹理在屏幕上的大小与相机距离纹理原点 ``1.0`` 单位时相同，忽略与相机的实际距离。\ :ref:`Camera3D` 的视野（使用正交/视锥模式时则为 :ref:`Camera3D.size`\ ）仍然会影响精灵绘制的大小。 .. rst-class:: classref-item-separator @@ -460,7 +460,9 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_offset**\ (\ ) -纹理的绘图偏移量。 +纹理绘制偏移。 + +\ **注意：**\ 在 Sprite3D 中增大 :ref:`offset`.y 会让精灵在世界中向上移动（即 +Y 朝上）。 .. rst-class:: classref-item-separator @@ -532,7 +534,7 @@ Alpha 裁剪丢弃数值的阈值。 - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) -纹理过滤标志。可选项见 :ref:`TextureFilter`\ 。 +纹理过滤标志。 \ **注意：**\ 线性过滤可能导致边缘的显示问题，对不透明纹理尤为明显。要避免这个问题，请使用具有透明边缘或边缘颜色一致的纹理。 @@ -604,9 +606,10 @@ Alpha 裁剪丢弃数值的阈值。 |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` -如果 ``true``\ ，则指定的标志将被启用。标志列表见 :ref:`DrawFlags`\ 。 +如果为 ``true``\ ，则将启用指定的标志。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_spriteframes.rst b/classes/zh_CN/class_spriteframes.rst index 6197b494a6..05dccd67f2 100644 --- a/classes/zh_CN/class_spriteframes.rst +++ b/classes/zh_CN/class_spriteframes.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SpriteFrames.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpriteFrames.xml. .. _class_SpriteFrames: @@ -295,6 +295,7 @@ SpriteFrames 设置 ``anim`` 动画中索引为 ``idx`` 的帧的纹理 ``texture`` 和持续时间 ``duration``\ 。\ ``duration`` 指定的是相对时长，详见 :ref:`get_frame_duration()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_standardmaterial3d.rst b/classes/zh_CN/class_standardmaterial3d.rst index fce4092e26..da306255d8 100644 --- a/classes/zh_CN/class_standardmaterial3d.rst +++ b/classes/zh_CN/class_standardmaterial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StandardMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StandardMaterial3D.xml. .. _class_StandardMaterial3D: @@ -29,6 +29,7 @@ StandardMaterial3D - :doc:`标准 3D 材质与 ORM 3D 材质 <../tutorials/3d/standard_material_3d>` .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_staticbody2d.rst b/classes/zh_CN/class_staticbody2d.rst index 7f7b22cb15..4935c39b26 100644 --- a/classes/zh_CN/class_staticbody2d.rst +++ b/classes/zh_CN/class_staticbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StaticBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StaticBody2D.xml. .. _class_StaticBody2D: @@ -27,6 +27,15 @@ StaticBody2D \ **StaticBody2D** 常用于完全静态的地板、墙壁等对象，也可以用于传送带、圆形回转平台等移动的表面（使用 :ref:`constant_linear_velocity` 和 :ref:`constant_angular_velocity`\ ）。 +.. rst-class:: classref-introduction-group + +教程 +---- + +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + .. rst-class:: classref-reftable-group 属性 @@ -102,6 +111,7 @@ StaticBody2D 如果为该属性指定了一种材质，则将使用该材质代替任何其他物理材质，例如继承的材质。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_staticbody3d.rst b/classes/zh_CN/class_staticbody3d.rst index ee04e6ab6a..1bc71d2560 100644 --- a/classes/zh_CN/class_staticbody3d.rst +++ b/classes/zh_CN/class_staticbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StaticBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StaticBody3D.xml. .. _class_StaticBody3D: @@ -32,6 +32,10 @@ StaticBody3D 教程 ---- +- :doc:`物理介绍 <../tutorials/physics/physics_introduction>` + +- :doc:`排查物理问题 <../tutorials/physics/troubleshooting_physics_issues>` + - `3D 物理测试演示 `__ - `第三人称射击（TPS）演示 `__ @@ -113,6 +117,7 @@ StaticBody3D 如果为该属性指定了一种材质，则将使用该材质代替任何其他物理材质，例如继承的材质。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_statusindicator.rst b/classes/zh_CN/class_statusindicator.rst index 631d04b64b..0a43094870 100644 --- a/classes/zh_CN/class_statusindicator.rst +++ b/classes/zh_CN/class_statusindicator.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StatusIndicator.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StatusIndicator.xml. .. _class_StatusIndicator: @@ -159,6 +159,7 @@ StatusIndicator 返回状态指示器的矩形，使用屏幕坐标。如果状态指示器不可见，则返回空的 :ref:`Rect2`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeer.rst b/classes/zh_CN/class_streampeer.rst index 4379e6333f..6ee42ce083 100644 --- a/classes/zh_CN/class_streampeer.rst +++ b/classes/zh_CN/class_streampeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeer.xml. .. _class_StreamPeer: @@ -258,7 +258,7 @@ StreamPeer 是一种抽象基类，常用于流式协议（例如 TCP）。它 :ref:`Array` **get_partial_data**\ (\ bytes\: :ref:`int`\ ) :ref:`🔗` -返回接收到的块数据。可以使用“bytes”参数设置所需接收的字节数。如果可用的字节数不足，该函数会返回实际接收到的数量。该函数返回两个值，一个 :ref:`Error` 错误码以及一个数据数组。 +返回接收到的字节数据块。要接收的字节数可以在 ``bytes`` 参数中请求。如果没有足够的字节数可用，该函数会返回实际接收到的数量。该函数返回两个值：\ :ref:`Error` 错误码和数据数组。 .. rst-class:: classref-item-separator @@ -573,6 +573,7 @@ StreamPeer 是一种抽象基类，常用于流式协议（例如 TCP）。它 内部实现时，使用的编码机制与 :ref:`@GlobalScope.var_to_bytes()` 方法相同。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeerbuffer.rst b/classes/zh_CN/class_streampeerbuffer.rst index 53185081b5..5513af6b36 100644 --- a/classes/zh_CN/class_streampeerbuffer.rst +++ b/classes/zh_CN/class_streampeerbuffer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeerBuffer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerBuffer.xml. .. _class_StreamPeerBuffer: @@ -159,6 +159,7 @@ StreamPeerBuffer 将指针移动到指定的位置。\ ``position`` 必须是 :ref:`data_array` 的有效索引。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeerextension.rst b/classes/zh_CN/class_streampeerextension.rst index 50431d9c27..81787d53c6 100644 --- a/classes/zh_CN/class_streampeerextension.rst +++ b/classes/zh_CN/class_streampeerextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerExtension.xml. .. _class_StreamPeerExtension: @@ -25,7 +25,7 @@ StreamPeerExtension :widths: auto +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_bytes`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_available_bytes`\ (\ ) |virtual| |required| |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_get_data`\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,7 +49,7 @@ StreamPeerExtension .. rst-class:: classref-method -:ref:`int` **_get_available_bytes**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_available_bytes**\ (\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -112,6 +112,7 @@ StreamPeerExtension 该方法目前没有描述，请帮我们\ :ref:`贡献一个 `\ 吧！ .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeergzip.rst b/classes/zh_CN/class_streampeergzip.rst index 60bfd07d9a..60851ece05 100644 --- a/classes/zh_CN/class_streampeergzip.rst +++ b/classes/zh_CN/class_streampeergzip.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeerGZIP.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerGZIP.xml. .. _class_StreamPeerGZIP: @@ -70,7 +70,9 @@ StreamPeerGZIP :ref:`Error` **finish**\ (\ ) :ref:`🔗` -终止该流，对缓冲中剩余的数据块进行压缩或解压缩。 +终止该流，对缓冲中剩余的数据块进行压缩。 + +只有在压缩时才能调用。 .. rst-class:: classref-item-separator @@ -97,6 +99,7 @@ StreamPeerGZIP 开始解压模式的流，缓冲区大小为 ``buffer_size``\ ，如果 ``use_deflate`` 为 ``true`` 则使用 deflate 而不是 GZIP。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeertcp.rst b/classes/zh_CN/class_streampeertcp.rst index 45de20c899..2ac15a5b4f 100644 --- a/classes/zh_CN/class_streampeertcp.rst +++ b/classes/zh_CN/class_streampeertcp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeerTCP.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTCP.xml. .. _class_StreamPeerTCP: @@ -80,7 +80,7 @@ enum **Status**: :ref:`🔗` :ref:`Status` **STATUS_CONNECTING** = ``1`` -表示连接到主机的 **StreamPeerTCP** 的状态。 +表示正在连接到主机的 **StreamPeerTCP** 的状态。 .. _class_StreamPeerTCP_constant_STATUS_CONNECTED: @@ -88,7 +88,7 @@ enum **Status**: :ref:`🔗` :ref:`Status` **STATUS_CONNECTED** = ``2`` -表示连接到主机的 **StreamPeerTCP** 的状态。 +表示已经连接到主机的 **StreamPeerTCP** 的状态。 .. _class_StreamPeerTCP_constant_STATUS_ERROR: @@ -187,7 +187,7 @@ enum **Status**: :ref:`🔗` :ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` -返回连接的状态，见\ :ref:`Status`\ 。 +返回连接的状态。 .. rst-class:: classref-item-separator @@ -216,6 +216,7 @@ enum **Status**: :ref:`🔗` \ **注意：**\ 对于发送大数据包或需要传输大量数据的应用程序，建议将本属性保持禁用，因为启用本属性会减少总体可用带宽。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_streampeertls.rst b/classes/zh_CN/class_streampeertls.rst index 8fd788af89..343db5c074 100644 --- a/classes/zh_CN/class_streampeertls.rst +++ b/classes/zh_CN/class_streampeertls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StreamPeerTLS.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTLS.xml. .. _class_StreamPeerTLS: @@ -158,7 +158,7 @@ enum **Status**: :ref:`🔗` :ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` -返回连接的状态。取值见 :ref:`Status`\ 。 +返回连接的状态。 .. rst-class:: classref-item-separator @@ -185,6 +185,7 @@ enum **Status**: :ref:`🔗` 轮询连接以检查传入的字节。在 :ref:`StreamPeer.get_available_bytes()` 之前调用它以使其正常工作。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_string.rst b/classes/zh_CN/class_string.rst index 64241aba56..2b5e863f66 100644 --- a/classes/zh_CN/class_string.rst +++ b/classes/zh_CN/class_string.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/String.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/String.xml. .. _class_String: @@ -77,7 +77,7 @@ String +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`casecmp_to`\ (\ to\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`chr`\ (\ char\: :ref:`int`\ ) |static| | + | :ref:`String` | :ref:`chr`\ (\ code\: :ref:`int`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`contains`\ (\ what\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -195,12 +195,20 @@ String +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + | :ref:`String` | :ref:`path_join`\ (\ path\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_chars`\ (\ chars\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_char`\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_chars`\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reverse`\ (\ ) |const| | @@ -247,8 +255,12 @@ String +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_kebab_case`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_multibyte_char_buffer`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | @@ -273,6 +285,8 @@ String +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_file_decode`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | @@ -492,7 +506,7 @@ String 与另一个字符串进行比较，区分大小写。小于时返回 ``-1``\ 、大于时返回 ``1``\ 、等于时返回 ``0``\ 。“小于”和“大于”比较的是字符串中的 `Unicode 码位 `__\ ，大致与字母表顺序一致。 -如果字符串长度不同，这个字符串比 ``to`` 字符串长时返回 ``1``\ ，短时返回 ``-1``\ 。请注意空字符串的长度\ *始终*\ 为 ``0``\ 。 +进行字符比较时，如果其中一个字符串已到达末尾，而另一个字符串中还有后续字符，则会使用长度作为决定因素：如果该字符串比 ``to`` 字符串长则返回 ``1``\ ，短则返回 ``-1``\ 。请注意，空字符串的长度始终为 ``0``\ 。 要从字符串比较中获得 :ref:`bool` 结果，请改用 ``==`` 运算符。另见 :ref:`nocasecmp_to()`\ 、\ :ref:`filecasecmp_to()` 和 :ref:`naturalcasecmp_to()`\ 。 @@ -504,15 +518,17 @@ String .. rst-class:: classref-method -:ref:`String` **chr**\ (\ char\: :ref:`int`\ ) |static| :ref:`🔗` +:ref:`String` **chr**\ (\ code\: :ref:`int`\ ) |static| :ref:`🔗` -根据十进制数 ``char`` 返回单一 Unicode 字符。你可以用 `unicodelookup.com `__ 和 `unicode.org `__ 作为参考。 +根据整数 ``code`` 返回单一 Unicode 字符。可以参考 `unicodelookup.com `__ 和 `unicode.org `__\ 。 :: print(String.chr(65)) # 输出 "A" print(String.chr(129302)) # 输出 "🤖"（机器人脸 Emoji） +另见 :ref:`unicode_at()`\ 、\ :ref:`@GDScript.char()`\ 、\ :ref:`@GDScript.ord()`\ 。 + .. rst-class:: classref-item-separator ---- @@ -663,7 +679,7 @@ String .. code-tab:: gdscript print("Team".find("I")) # 输出 -1 - + print("Potato".find("t")) # 输出 2 print("Potato".find("t", 3)) # 输出 4 print("Potato".find("t", 5)) # 输出 -1 @@ -671,7 +687,7 @@ String .. code-tab:: csharp GD.Print("Team".Find("I")); // 输出 -1 - + GD.Print("Potato".Find("t")); // 输出 2 GD.Print("Potato".Find("t", 3)); // 输出 4 GD.Print("Potato".Find("t", 5)); // 输出 -1 @@ -711,7 +727,7 @@ String # 输出“Waiting for Godot 是 Samuel Beckett 的戏剧，Godot 引擎由此得名。” var use_array_values = "Waiting for {0} 是 {1} 的戏剧，{0} 引擎由此得名。" print(use_array_values.format(["Godot", "Samuel Beckett"])) - + # 输出“第 42 号用户是 Godot。” print("第 {id} 号用户是 {name}。".format({"id": 42, "name": "Godot"})) @@ -794,7 +810,7 @@ String var b = "cool.txt".get_extension() # b 为 "txt" var c = "cool.font.tres".get_extension() # c 为 "tres" var d = ".pack1".get_extension() # d 为 "pack1" - + var e = "file.txt.".get_extension() # e 为 "" var f = "file.txt..".get_extension() # f 为 "" var g = "txt".get_extension() # g 为 "" @@ -893,13 +909,13 @@ String var text = "hello world" var encoded = text.to_utf8_buffer().hex_encode() # 输出 "68656c6c6f20776f726c64" - print(buf.hex_decode().get_string_from_utf8()) + print(encoded.hex_decode().get_string_from_utf8()) .. code-tab:: csharp var text = "hello world"; var encoded = text.ToUtf8Buffer().HexEncode(); // 输出 "68656c6c6f20776f726c64" - GD.Print(buf.HexDecode().GetStringFromUtf8()); + GD.Print(encoded.HexDecode().GetStringFromUtf8()); @@ -1018,12 +1034,12 @@ String :ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` -如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，则返回 ``true``\ 。 +如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，则返回 ``true``\ 。与 :ref:`contains()` 不同。 :: var text = "Wow, incredible!" - + print("inedible".is_subsequence_of(text)) # 输出 true print("Word!".is_subsequence_of(text)) # 输出 true print("Window".is_subsequence_of(text)) # 输出 false @@ -1039,7 +1055,7 @@ String :ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` -如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，\ **忽略大小写**\ ，则返回 ``true``\ 。 +如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，\ **忽略大小写**\ ，则返回 ``true``\ 。与 :ref:`containsn()` 不同。 .. rst-class:: classref-item-separator @@ -1072,7 +1088,7 @@ String :ref:`bool` **is_valid_filename**\ (\ ) |const| :ref:`🔗` -如果该字符串不包含文件名中不允许的字符，则返回 ``true``\ （不允许的字符有：\ ``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``\ ）。 +如果该字符串为有效的文件名，则返回 ``true``\ 。有效的文件名不能为空、头尾不能是空白字符、不包含不允许的字符（\ ``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``\ ）。 .. rst-class:: classref-item-separator @@ -1112,7 +1128,7 @@ String print("A08E".is_valid_hex_number()) # 输出 true print("-AbCdEf".is_valid_hex_number()) # 输出 true print("2.5".is_valid_hex_number()) # 输出 false - + print("0xDEADC0DE".is_valid_hex_number(true)) # 输出 true .. rst-class:: classref-item-separator @@ -1225,14 +1241,14 @@ String .. code-tab:: gdscript var fruits = ["Apple", "Orange", "Pear", "Kiwi"] - + print(", ".join(fruits)) # 输出 "Apple, Orange, Pear, Kiwi" print("---".join(fruits)) # 输出 "Apple---Orange---Pear---Kiwi" .. code-tab:: csharp string[] fruits = ["Apple", "Orange", "Pear", "Kiwi"]; - + // 这个方法在 C# 中是静态的。 GD.Print(string.Join(", ", fruits)); // 输出 "Apple, Orange, Pear, Kiwi" GD.Print(string.Join("---", fruits)); // 输出 "Apple---Orange---Pear---Kiwi" @@ -1368,7 +1384,7 @@ String 使用自然顺序进行排序时，会和常见预期一样将连续的数字进行组合，而不是一个个数字进行比较。排序后的数列为 ``["1", "2", "3", ...]`` 而不是 ``["1", "10", "2", "3", ...]``\ 。 -如果字符串长度不同，这个字符串比 ``to`` 字符串长时返回 ``1``\ ，短时返回 ``-1``\ 。请注意空字符串的长度\ *始终*\ 为 ``0``\ 。 +进行字符比较时，如果其中一个字符串已到达末尾，而另一个字符串中还有后续字符，则会使用长度作为决定因素：如果该字符串比 ``to`` 字符串长则返回 ``1``\ ，短则返回 ``-1``\ 。请注意，空字符串的长度始终为 ``0``\ 。 要从字符串比较中获得 :ref:`bool` 结果，请改用 ``==`` 运算符。另见 :ref:`naturalnocasecmp_to()`\ 、\ :ref:`filecasecmp_to()` 和 :ref:`nocasecmp_to()`\ 。 @@ -1386,7 +1402,7 @@ String 使用自然顺序进行排序时，会和常见预期一样将连续的数字进行组合，而不是一个个数字进行比较。排序后的数列为 ``["1", "2", "3", ...]`` 而不是 ``["1", "10", "2", "3", ...]``\ 。 -如果字符串长度不同，这个字符串比 ``to`` 字符串长时返回 ``1``\ ，短时返回 ``-1``\ 。请注意空字符串的长度\ *始终*\ 为 ``0``\ 。 +进行字符比较时，如果其中一个字符串已到达末尾，而另一个字符串中还有后续字符，则会使用长度作为决定因素：如果该字符串比 ``to`` 字符串长则返回 ``1``\ ，短则返回 ``-1``\ 。请注意，空字符串的长度始终为 ``0``\ 。 要从字符串比较中获得 :ref:`bool` 结果，请改用 ``==`` 运算符。另见 :ref:`naturalcasecmp_to()`\ 、\ :ref:`filenocasecmp_to()` 和 :ref:`casecmp_to()`\ 。 @@ -1402,7 +1418,7 @@ String 与另一个字符串进行\ **不区分大小写**\ 的比较。小于时返回 ``-1``\ 、大于时返回 ``1``\ 、等于时返回 ``0``\ 。“小于”和“大于”比较的是字符串中的 `Unicode 码位 `__\ ，大致与字母表顺序一致。内部实现时，会将小写字符转换为大写后进行比较。 -如果字符串长度不同，这个字符串比 ``to`` 字符串长时返回 ``1``\ ，短时返回 ``-1``\ 。请注意空字符串的长度\ *始终*\ 为 ``0``\ 。 +进行字符比较时，如果其中一个字符串已到达末尾，而另一个字符串中还有后续字符，则会使用长度作为决定因素：如果该字符串比 ``to`` 字符串长则返回 ``1``\ ，短则返回 ``-1``\ 。请注意，空字符串的长度始终为 ``0``\ 。 要从字符串比较中获得 :ref:`bool` 结果，请改用 ``==`` 运算符。另见 :ref:`casecmp_to()`\ 、\ :ref:`filenocasecmp_to()` 和 :ref:`naturalnocasecmp_to()`\ 。 @@ -1427,11 +1443,11 @@ String String.num(3.141593) # 返回 "3.141593" String.num(3.141593, 3) # 返回 "3.142" String.num(3.14159300) # 返回 "3.141593" - + # 此处的最后一位数字会进位， # 数字位数会减少，因为后缀的零会被移除： String.num(42.129999, 5) # 返回 "42.13" - + # 如果没有指定 `decimals`，最大有效位数为 14： String.num(-0.0000012345432123454321) # 返回 "-0.00000123454321" String.num(-10000.0000012345432123454321) # 返回 "-10000.0000012345" @@ -1462,7 +1478,7 @@ String :ref:`String` **num_scientific**\ (\ number\: :ref:`float`\ ) |static| :ref:`🔗` -将给定的数字 ``number`` 转换为字符串表示，使用科学记数法。 +将数字 ``number`` 转换为字符串表示，使用科学记数法。 .. tabs:: @@ -1483,7 +1499,7 @@ String -\ **注意：**\ 这个方法没有在 C# 中实现。要实现类似的效果，见 C# 的\ `标准数字格式字符串 `__ +\ **注意：**\ 这个方法没有在 C# 中实现。要实现类似的效果，见 C# 的\ `标准数字格式字符串 `__\ 。 .. rst-class:: classref-item-separator @@ -1533,9 +1549,9 @@ String .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` +:ref:`String` **path_join**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` -将 ``file`` 作为子路径连接到该字符串的末尾，必要时会添加 ``/``\ 。 +将 ``path`` 作为子路径连接到该字符串的末尾，必要时会添加 ``/``\ 。 \ **示例：**\ ``"this/is".path_join("path") == "this/is/path"``\ 。 @@ -1543,6 +1559,30 @@ String ---- +.. _class_String_method_remove_char: + +.. rst-class:: classref-method + +:ref:`String` **remove_char**\ (\ what\: :ref:`int`\ ) |const| :ref:`🔗` + +移除字符串中出现的所有码位为 ``what`` 的 Unicode 字符。相较于调用 :ref:`replace()` 时键为单字符串且替换为 ``""`` 要快。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_remove_chars: + +.. rst-class:: classref-method + +:ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` + +移除字符串中出现的所有包含在 ``chars`` 中的字符。另见 :ref:`remove_char()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_repeat: .. rst-class:: classref-method @@ -1567,6 +1607,30 @@ String ---- +.. _class_String_method_replace_char: + +.. rst-class:: classref-method + +:ref:`String` **replace_char**\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +将所有代码为 ``key`` 的 Unicode 字符都替换为代码为 ``with`` 的 Unicode 字符。这是 :ref:`replace()` 针对替换目标为单个字符的特化版本，速度更快。获取单个字符请使用 ``"X".unicode_at(0)``\ （请注意，合成字符、Emoji 等字符串是由多个 Unicode 码位构成的，无法使用该方法，请使用 :ref:`length()` 判断）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_replace_chars: + +.. rst-class:: classref-method + +:ref:`String` **replace_chars**\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +将该字符串中出现的所有 ``keys`` 中的字符都替换为码位为 ``with`` 的 Unicode 字符。另见 :ref:`replace_char()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_replacen: .. rst-class:: classref-method @@ -1663,7 +1727,7 @@ String var some_string = "One,Two,Three,Four" var some_array = some_string.rsplit(",", true, 1) - + print(some_array.size()) # 输出 2 print(some_array[0]) # 输出“One,Two,Three” print(some_array[1]) # 输出“Four” @@ -1794,7 +1858,7 @@ String .. code-tab:: gdscript var some_array = "One,Two,Three,Four".split(",", true, 2) - + print(some_array.size()) # 输出 3 print(some_array[0]) # 输出“One” print(some_array[1]) # 输出“Two” @@ -1804,7 +1868,7 @@ String // C# 的 `Split()` 不支持 `maxsplit` 参数。 var someArray = "One,Two,Three".Split(","); - + GD.Print(someArray[0]); // 输出“One” GD.Print(someArray[1]); // 输出“Two” GD.Print(someArray[2]); // 输出“Three,Four” @@ -1893,7 +1957,7 @@ String :ref:`String` **to_camel_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为小驼峰命名 ``camelCase`` 的结果。 +返回将该字符串转换为小驼峰命名法 ``camelCase`` 的结果。 .. rst-class:: classref-item-separator @@ -1934,6 +1998,37 @@ String var c = "-1.2.3".to_int() # c 为 -1 var d = "Hello!".to_int() # d 为 0 +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_to_kebab_case: + +.. rst-class:: classref-method + +:ref:`String` **to_kebab_case**\ (\ ) |const| :ref:`🔗` + +返回将该字符串转换为烤串命名法 ``kebab-case`` 的结果。 + +\ **注意：**\ 如果数字后跟着的是\ *单个*\ 字母，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_kebab_case() # 返回 "node-2d" + "2nd place".to_kebab_case() # 返回 "2-nd-place" + "Texture3DAssetFolder".to_kebab_case() # 返回 "texture-3d-asset-folder" + + .. code-tab:: csharp + + "Node2D".ToKebabCase(); // 返回 "node-2d" + "2nd place".ToKebabCase(); // 返回 "2-nd-place" + "Texture3DAssetFolder".ToKebabCase(); // 返回 "texture-3d-asset-folder" + + + .. rst-class:: classref-item-separator ---- @@ -1950,13 +2045,31 @@ String ---- +.. _class_String_method_to_multibyte_char_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_multibyte_char_buffer**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +将字符串转换为使用系统多字节代码页编码的 :ref:`PackedByteArray`\ 。如果转换失败，则会返回空数组。 + +\ ``encoding`` 的有效值由系统决定。如果 ``encoding`` 为空字符串，则会使用系统默认的编码。 + +- 对于 Windows，见\ `代码页标识符 `__ .NET 名称。 + +- 对于 macOS 和 Linux/BSD，支持的编码列表见 ``libiconv`` 库文档及 ``iconv --list``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_to_pascal_case: .. rst-class:: classref-method :ref:`String` **to_pascal_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为大驼峰命名 ``PascalCase`` 的结果。 +返回将该字符串转换为大驼峰命名法 ``PascalCase`` 的结果。 .. rst-class:: classref-item-separator @@ -1968,9 +2081,9 @@ String :ref:`String` **to_snake_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为蛇形命名 ``snake_case`` 的结果。 +返回将该字符串转换为蛇形命名法 ``snake_case`` 的结果。 -\ **注意：**\ 如果数字之后存在的是\ *单个*\ 字符，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 +\ **注意：**\ 如果数字后跟着的是\ *单个*\ 字母，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 .. tabs:: @@ -2083,7 +2196,9 @@ String :ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| :ref:`🔗` -返回位于 ``at`` 处的字符的代码。 +返回位于 ``at`` 的字符代码。 + +另见 :ref:`chr()`\ 、\ :ref:`@GDScript.char()`\ 、\ :ref:`@GDScript.ord()`\ 。 .. rst-class:: classref-item-separator @@ -2095,7 +2210,7 @@ String :ref:`String` **uri_decode**\ (\ ) |const| :ref:`🔗` -将该字符串从 URL 编码格式中解码。该方法的目的是在收到 HTTP 请求时正确解码 URL 中的参数。另见 :ref:`uri_encode()`\ 。 +将该字符串按照 URL 编码格式进行解码。该方法可以在收到 HTTP 请求时正确解码 URL 中的参数。另见 :ref:`uri_encode()`\ 。 .. tabs:: @@ -2112,6 +2227,8 @@ String +\ **注意：**\ 这个方法会将 ``+`` 解码为空格。 + .. rst-class:: classref-item-separator ---- @@ -2131,18 +2248,30 @@ String var prefix = "$DOCS_URL/?highlight=" var url = prefix + "Godot Engine:docs".uri_encode() - + print(url) # 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs" .. code-tab:: csharp var prefix = "$DOCS_URL/?highlight="; var url = prefix + "Godot Engine:docs".URIEncode(); - + GD.Print(url); // 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs" +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_uri_file_decode: + +.. rst-class:: classref-method + +:ref:`String` **uri_file_decode**\ (\ ) |const| :ref:`🔗` + +按照 URL 编码格式解析文件路径。与 :ref:`uri_decode()` 不同，该方法会保留 ``+``\ 。 + .. rst-class:: classref-item-separator ---- @@ -2206,7 +2335,7 @@ String :ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) :ref:`🔗` -如果两个字符串不以相同的字符序列开头，则返回 ``true``\ 。 +如果两个字符串包含的字符序列不同，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -2235,7 +2364,7 @@ String :: print("我捉到了 %d 条鱼！" % 2) # 输出 "我捉到了 2 条鱼！" - + var my_message = "正在前往 %s，速度为 %2.2f km/h。" var location = "深谷" var speed = 40.3485 @@ -2303,7 +2432,7 @@ String :ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) :ref:`🔗` -如果两个字符串以相同的字符序列开头，则返回 ``true``\ 。 +如果两个字符串包含的字符序列相同，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -2354,6 +2483,7 @@ String 返回只包含索引为 ``index`` 的字符的新 **String**\ 。索引从 ``0`` 开始。如果 ``index`` 大于等于 ``0``\ ，则字符是从该字符串的开头开始获取的。如果 ``index`` 为负，则从末尾开始获取。越界访问字符串会导致运行时错误，从编辑器中运行时会将项目暂停。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_stringname.rst b/classes/zh_CN/class_stringname.rst index b0c8c1d884..ae0c7b65b6 100644 --- a/classes/zh_CN/class_stringname.rst +++ b/classes/zh_CN/class_stringname.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StringName.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StringName.xml. .. _class_StringName: @@ -178,12 +178,20 @@ StringName +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + | :ref:`String` | :ref:`path_join`\ (\ path\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_chars`\ (\ chars\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_char`\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_chars`\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reverse`\ (\ ) |const| | @@ -230,8 +238,12 @@ StringName +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_kebab_case`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_multibyte_char_buffer`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | @@ -256,6 +268,8 @@ StringName +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_file_decode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | @@ -617,7 +631,7 @@ StringName .. code-tab:: gdscript print("Team".find("I")) # 输出 -1 - + print("Potato".find("t")) # 输出 2 print("Potato".find("t", 3)) # 输出 4 print("Potato".find("t", 5)) # 输出 -1 @@ -625,7 +639,7 @@ StringName .. code-tab:: csharp GD.Print("Team".Find("I")); // 输出 -1 - + GD.Print("Potato".Find("t")); // 输出 2 GD.Print("Potato".Find("t", 3)); // 输出 4 GD.Print("Potato".Find("t", 5)); // 输出 -1 @@ -665,7 +679,7 @@ StringName # 输出“Waiting for Godot 是 Samuel Beckett 的戏剧，Godot 引擎由此得名。” var use_array_values = "Waiting for {0} 是 {1} 的戏剧，{0} 引擎由此得名。" print(use_array_values.format(["Godot", "Samuel Beckett"])) - + # 输出“第 42 号用户是 Godot。” print("第 {id} 号用户是 {name}。".format({"id": 42, "name": "Godot"})) @@ -748,7 +762,7 @@ StringName var b = "cool.txt".get_extension() # b 为 "txt" var c = "cool.font.tres".get_extension() # c 为 "tres" var d = ".pack1".get_extension() # d 为 "pack1" - + var e = "file.txt.".get_extension() # e 为 "" var f = "file.txt..".get_extension() # f 为 "" var g = "txt".get_extension() # g 为 "" @@ -847,13 +861,13 @@ StringName var text = "hello world" var encoded = text.to_utf8_buffer().hex_encode() # 输出 "68656c6c6f20776f726c64" - print(buf.hex_decode().get_string_from_utf8()) + print(encoded.hex_decode().get_string_from_utf8()) .. code-tab:: csharp var text = "hello world"; var encoded = text.ToUtf8Buffer().HexEncode(); // 输出 "68656c6c6f20776f726c64" - GD.Print(buf.HexDecode().GetStringFromUtf8()); + GD.Print(encoded.HexDecode().GetStringFromUtf8()); @@ -958,12 +972,12 @@ StringName :ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` -如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，则返回 ``true``\ 。 +如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，则返回 ``true``\ 。与 :ref:`contains()` 不同。 :: var text = "Wow, incredible!" - + print("inedible".is_subsequence_of(text)) # 输出 true print("Word!".is_subsequence_of(text)) # 输出 true print("Window".is_subsequence_of(text)) # 输出 false @@ -979,7 +993,7 @@ StringName :ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` -如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，\ **忽略大小写**\ ，则返回 ``true``\ 。 +如果这个字符串中的所有字符都能在 ``text`` 中按照原始顺序找到，\ **忽略大小写**\ ，则返回 ``true``\ 。与 :ref:`containsn()` 不同。 .. rst-class:: classref-item-separator @@ -1012,7 +1026,7 @@ StringName :ref:`bool` **is_valid_filename**\ (\ ) |const| :ref:`🔗` -如果该字符串不包含文件名中不允许的字符，则返回 ``true``\ （不允许的字符有：\ ``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``\ ）。 +如果该字符串为有效的文件名，则返回 ``true``\ 。有效的文件名不能为空、头尾不能是空白字符、不包含不允许的字符（\ ``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``\ ）。 .. rst-class:: classref-item-separator @@ -1052,7 +1066,7 @@ StringName print("A08E".is_valid_hex_number()) # 输出 true print("-AbCdEf".is_valid_hex_number()) # 输出 true print("2.5".is_valid_hex_number()) # 输出 false - + print("0xDEADC0DE".is_valid_hex_number(true)) # 输出 true .. rst-class:: classref-item-separator @@ -1165,14 +1179,14 @@ StringName .. code-tab:: gdscript var fruits = ["Apple", "Orange", "Pear", "Kiwi"] - + print(", ".join(fruits)) # 输出 "Apple, Orange, Pear, Kiwi" print("---".join(fruits)) # 输出 "Apple---Orange---Pear---Kiwi" .. code-tab:: csharp string[] fruits = ["Apple", "Orange", "Pear", "Kiwi"]; - + // 这个方法在 C# 中是静态的。 GD.Print(string.Join(", ", fruits)); // 输出 "Apple, Orange, Pear, Kiwi" GD.Print(string.Join("---", fruits)); // 输出 "Apple---Orange---Pear---Kiwi" @@ -1378,9 +1392,9 @@ StringName .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` +:ref:`String` **path_join**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` -将 ``file`` 作为子路径连接到该字符串的末尾，必要时会添加 ``/``\ 。 +将 ``path`` 作为子路径连接到该字符串的末尾，必要时会添加 ``/``\ 。 \ **示例：**\ ``"this/is".path_join("path") == "this/is/path"``\ 。 @@ -1388,6 +1402,30 @@ StringName ---- +.. _class_StringName_method_remove_char: + +.. rst-class:: classref-method + +:ref:`String` **remove_char**\ (\ what\: :ref:`int`\ ) |const| :ref:`🔗` + +移除字符串中出现的所有码位为 ``what`` 的 Unicode 字符。相较于调用 :ref:`replace()` 时键为单字符串且替换为 ``""`` 要快。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_remove_chars: + +.. rst-class:: classref-method + +:ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` + +移除字符串中出现的所有包含在 ``chars`` 中的字符。另见 :ref:`remove_char()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_repeat: .. rst-class:: classref-method @@ -1412,6 +1450,30 @@ StringName ---- +.. _class_StringName_method_replace_char: + +.. rst-class:: classref-method + +:ref:`String` **replace_char**\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +将所有代码为 ``key`` 的 Unicode 字符都替换为代码为 ``with`` 的 Unicode 字符。这是 :ref:`replace()` 针对替换目标为单个字符的特化版本，速度更快。获取单个字符请使用 ``"X".unicode_at(0)``\ （请注意，合成字符、Emoji 等字符串是由多个 Unicode 码位构成的，无法使用该方法，请使用 :ref:`length()` 判断）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_replace_chars: + +.. rst-class:: classref-method + +:ref:`String` **replace_chars**\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +将该字符串中出现的所有 ``keys`` 中的字符都替换为码位为 ``with`` 的 Unicode 字符。另见 :ref:`replace_char()`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_replacen: .. rst-class:: classref-method @@ -1508,7 +1570,7 @@ StringName var some_string = "One,Two,Three,Four" var some_array = some_string.rsplit(",", true, 1) - + print(some_array.size()) # 输出 2 print(some_array[0]) # 输出“One,Two,Three” print(some_array[1]) # 输出“Four” @@ -1639,7 +1701,7 @@ StringName .. code-tab:: gdscript var some_array = "One,Two,Three,Four".split(",", true, 2) - + print(some_array.size()) # 输出 3 print(some_array[0]) # 输出“One” print(some_array[1]) # 输出“Two” @@ -1649,7 +1711,7 @@ StringName // C# 的 `Split()` 不支持 `maxsplit` 参数。 var someArray = "One,Two,Three".Split(","); - + GD.Print(someArray[0]); // 输出“One” GD.Print(someArray[1]); // 输出“Two” GD.Print(someArray[2]); // 输出“Three,Four” @@ -1738,7 +1800,7 @@ StringName :ref:`String` **to_camel_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为小驼峰命名 ``camelCase`` 的结果。 +返回将该字符串转换为小驼峰命名法 ``camelCase`` 的结果。 .. rst-class:: classref-item-separator @@ -1779,6 +1841,37 @@ StringName var c = "-1.2.3".to_int() # c 为 -1 var d = "Hello!".to_int() # d 为 0 +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_to_kebab_case: + +.. rst-class:: classref-method + +:ref:`String` **to_kebab_case**\ (\ ) |const| :ref:`🔗` + +返回将该字符串转换为烤串命名法 ``kebab-case`` 的结果。 + +\ **注意：**\ 如果数字后跟着的是\ *单个*\ 字母，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_kebab_case() # 返回 "node-2d" + "2nd place".to_kebab_case() # 返回 "2-nd-place" + "Texture3DAssetFolder".to_kebab_case() # 返回 "texture-3d-asset-folder" + + .. code-tab:: csharp + + "Node2D".ToKebabCase(); // 返回 "node-2d" + "2nd place".ToKebabCase(); // 返回 "2-nd-place" + "Texture3DAssetFolder".ToKebabCase(); // 返回 "texture-3d-asset-folder" + + + .. rst-class:: classref-item-separator ---- @@ -1795,13 +1888,31 @@ StringName ---- +.. _class_StringName_method_to_multibyte_char_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_multibyte_char_buffer**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +将字符串转换为使用系统多字节代码页编码的 :ref:`PackedByteArray`\ 。如果转换失败，则会返回空数组。 + +\ ``encoding`` 的有效值由系统决定。如果 ``encoding`` 为空字符串，则会使用系统默认的编码。 + +- 对于 Windows，见\ `代码页标识符 `__ .NET 名称。 + +- 对于 macOS 和 Linux/BSD，支持的编码列表见 ``libiconv`` 库文档及 ``iconv --list``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_to_pascal_case: .. rst-class:: classref-method :ref:`String` **to_pascal_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为大驼峰命名 ``PascalCase`` 的结果。 +返回将该字符串转换为大驼峰命名法 ``PascalCase`` 的结果。 .. rst-class:: classref-item-separator @@ -1813,9 +1924,9 @@ StringName :ref:`String` **to_snake_case**\ (\ ) |const| :ref:`🔗` -返回将该字符串转换为蛇形命名 ``snake_case`` 的结果。 +返回将该字符串转换为蛇形命名法 ``snake_case`` 的结果。 -\ **注意：**\ 如果数字之后存在的是\ *单个*\ 字符，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 +\ **注意：**\ 如果数字后跟着的是\ *单个*\ 字母，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。 .. tabs:: @@ -1928,7 +2039,9 @@ StringName :ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| :ref:`🔗` -返回位于 ``at`` 处的字符的代码。 +返回位于 ``at`` 的字符代码。 + +另见 :ref:`String.chr()`\ 、\ :ref:`@GDScript.char()`\ 、\ :ref:`@GDScript.ord()`\ 。 .. rst-class:: classref-item-separator @@ -1940,7 +2053,7 @@ StringName :ref:`String` **uri_decode**\ (\ ) |const| :ref:`🔗` -将该字符串从 URL 编码格式中解码。该方法的目的是在收到 HTTP 请求时正确解码 URL 中的参数。另见 :ref:`uri_encode()`\ 。 +将该字符串按照 URL 编码格式进行解码。该方法可以在收到 HTTP 请求时正确解码 URL 中的参数。另见 :ref:`uri_encode()`\ 。 .. tabs:: @@ -1957,6 +2070,8 @@ StringName +\ **注意：**\ 这个方法会将 ``+`` 解码为空格。 + .. rst-class:: classref-item-separator ---- @@ -1976,18 +2091,30 @@ StringName var prefix = "$DOCS_URL/?highlight=" var url = prefix + "Godot Engine:docs".uri_encode() - + print(url) # 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs" .. code-tab:: csharp var prefix = "$DOCS_URL/?highlight="; var url = prefix + "Godot Engine:docs".URIEncode(); - + GD.Print(url); // 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs" +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_uri_file_decode: + +.. rst-class:: classref-method + +:ref:`String` **uri_file_decode**\ (\ ) |const| :ref:`🔗` + +按照 URL 编码格式解析文件路径。与 :ref:`uri_decode()` 不同，该方法会保留 ``+``\ 。 + .. rst-class:: classref-item-separator ---- @@ -2178,6 +2305,7 @@ StringName 如果左侧的 **StringName** 的指针比 ``right`` 靠后或相同，则返回 ``true``\ 。注意，这与 `Unicode 顺序 `__\ 是不同的。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_stylebox.rst b/classes/zh_CN/class_stylebox.rst index b32d7ff169..c4d4e03369 100644 --- a/classes/zh_CN/class_stylebox.rst +++ b/classes/zh_CN/class_stylebox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StyleBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBox.xml. .. _class_StyleBox: @@ -51,33 +51,33 @@ StyleBox .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_draw`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_get_draw_rect`\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_minimum_size`\ (\ ) |virtual| |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw`\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_content_margin`\ (\ margin\: :ref:`Side`\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CanvasItem` | :ref:`get_current_item_drawn`\ (\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_margin`\ (\ margin\: :ref:`Side`\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_offset`\ (\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_content_margin`\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_content_margin_all`\ (\ offset\: :ref:`float`\ ) | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |required| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_get_draw_rect`\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_minimum_size`\ (\ ) |virtual| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_content_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CanvasItem` | :ref:`get_current_item_drawn`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_offset`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_content_margin`\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_content_margin_all`\ (\ offset\: :ref:`float`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -177,7 +177,7 @@ StyleBox .. rst-class:: classref-method -|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| :ref:`🔗` +|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |required| |const| :ref:`🔗` .. container:: contribute @@ -336,6 +336,7 @@ StyleBox 测试矩形中的一个位置，返回它是否通过掩码测试。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_styleboxempty.rst b/classes/zh_CN/class_styleboxempty.rst index 481a562235..4bb4d3c635 100644 --- a/classes/zh_CN/class_styleboxempty.rst +++ b/classes/zh_CN/class_styleboxempty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StyleBoxEmpty.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxEmpty.xml. .. _class_StyleBoxEmpty: @@ -22,6 +22,7 @@ StyleBoxEmpty 空的 :ref:`StyleBox`\ ，可以用来代替默认样式，什么都不显示（例如能够“禁用”\ ``focus`` 样式）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_styleboxflat.rst b/classes/zh_CN/class_styleboxflat.rst index ecb0390f6c..64ac856fb7 100644 --- a/classes/zh_CN/class_styleboxflat.rst +++ b/classes/zh_CN/class_styleboxflat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StyleBoxFlat.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxFlat.xml. .. _class_StyleBoxFlat: @@ -575,7 +575,7 @@ StyleBox的背景颜色。 :ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| :ref:`🔗` -返回给定角 ``corner`` 的半径。可能的取值见 :ref:`Corner`\ 。 +返回 ``corner`` 中指定的角落的圆角半径。 .. rst-class:: classref-item-separator @@ -623,7 +623,7 @@ StyleBox的背景颜色。 |void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) :ref:`🔗` -将给定角 ``corner`` 的圆角半径设置为 ``radius`` 像素。可能的取值见 :ref:`Corner`\ 。 +将 ``corner`` 中指定的角落的圆角半径设置为 ``radius`` 像素。 .. rst-class:: classref-item-separator @@ -662,6 +662,7 @@ StyleBox的背景颜色。 将所有边的扩展边距都设置为 ``size`` 像素。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_styleboxline.rst b/classes/zh_CN/class_styleboxline.rst index 4123447ca0..b98a0d0da5 100644 --- a/classes/zh_CN/class_styleboxline.rst +++ b/classes/zh_CN/class_styleboxline.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StyleBoxLine.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxLine.xml. .. _class_StyleBoxLine: @@ -132,6 +132,7 @@ StyleBoxLine 如果为 ``true``\ ，则该线将是垂直的。如果 ``false``\ ，该线将是水平的。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_styleboxtexture.rst b/classes/zh_CN/class_styleboxtexture.rst index cd664fa240..27430d0845 100644 --- a/classes/zh_CN/class_styleboxtexture.rst +++ b/classes/zh_CN/class_styleboxtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/StyleBoxTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxTexture.xml. .. _class_StyleBoxTexture: @@ -140,7 +140,7 @@ enum **AxisStretchMode**: :ref:`🔗` - |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_h_axis_stretch_mode**\ (\ ) -控制如何水平拉伸或平铺样式盒的纹理。可能的取值见 :ref:`AxisStretchMode`\ 。 +控制如何水平拉伸或平铺样式盒的纹理。 .. rst-class:: classref-item-separator @@ -157,7 +157,7 @@ enum **AxisStretchMode**: :ref:`🔗` - |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_v_axis_stretch_mode**\ (\ ) -控制如何垂直拉伸或平铺样式盒的纹理。可能的取值见 :ref:`AxisStretchMode`\ 。 +控制如何垂直拉伸或平铺样式盒的纹理。 .. rst-class:: classref-item-separator @@ -461,6 +461,7 @@ enum **AxisStretchMode**: :ref:`🔗` 将所有边的边距都设置为 ``size`` 像素。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_subtweentweener.rst b/classes/zh_CN/class_subtweentweener.rst index 99fb4e5b41..7cb2f85817 100644 --- a/classes/zh_CN/class_subtweentweener.rst +++ b/classes/zh_CN/class_subtweentweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SubtweenTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubtweenTweener.xml. .. _class_SubtweenTweener: @@ -53,6 +53,7 @@ SubtweenTweener 设置该 **SubtweenTweener** 开始运行子补间的时间，单位为秒。默认无延迟。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_subviewport.rst b/classes/zh_CN/class_subviewport.rst index db4a7aea44..6367ccef90 100644 --- a/classes/zh_CN/class_subviewport.rst +++ b/classes/zh_CN/class_subviewport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SubViewport.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubViewport.xml. .. _class_SubViewport: @@ -250,6 +250,7 @@ enum **UpdateMode**: :ref:`🔗` 如果为 ``true``\ ，则 2D 尺寸覆盖也会影响拉伸。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_subviewportcontainer.rst b/classes/zh_CN/class_subviewportcontainer.rst index 40ac3f547d..870cbcbf0a 100644 --- a/classes/zh_CN/class_subviewportcontainer.rst +++ b/classes/zh_CN/class_subviewportcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SubViewportContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubViewportContainer.xml. .. _class_SubViewportContainer: @@ -141,6 +141,7 @@ SubViewportContainer 由用户实现的虚方法。如果它返回 ``true``\ ，则 ``event`` 将被传播到 :ref:`SubViewport` 子级。如果返回 ``false``\ ，则传播不会发生。如果未实现该功能，则所有事件都会被传播到子视口。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_surfacetool.rst b/classes/zh_CN/class_surfacetool.rst index 618cbe68ba..1b2f26c928 100644 --- a/classes/zh_CN/class_surfacetool.rst +++ b/classes/zh_CN/class_surfacetool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SurfaceTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SurfaceTool.xml. .. _class_SurfaceTool: @@ -678,6 +678,7 @@ enum **SkinWeightCount**: :ref:`🔗` 指定用于\ *下一个*\ 顶点的权重值。\ ``weights`` 必须包含 4 个值。如果每个顶点都需要设置该信息，且为第一个顶点提交失败，则可能根本不会使用该信息。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_syntaxhighlighter.rst b/classes/zh_CN/class_syntaxhighlighter.rst index 50a4b0666a..1f0ddcc0a2 100644 --- a/classes/zh_CN/class_syntaxhighlighter.rst +++ b/classes/zh_CN/class_syntaxhighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SyntaxHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SyntaxHighlighter.xml. .. _class_SyntaxHighlighter: @@ -160,6 +160,7 @@ SyntaxHighlighter \ **注意：**\ 当关联的 :ref:`TextEdit` 节点更新它自己的缓存时，该函数会被自动调用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_systemfont.rst b/classes/zh_CN/class_systemfont.rst index 987053e933..dad66884b3 100644 --- a/classes/zh_CN/class_systemfont.rst +++ b/classes/zh_CN/class_systemfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/SystemFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SystemFont.xml. .. _class_SystemFont: @@ -60,6 +60,8 @@ SystemFont +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`keep_rounding_remainders` | ``true`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``16`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -269,6 +271,23 @@ SystemFont ---- +.. _class_SystemFont_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_modulate_color_glyphs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_modulate_color_glyphs**\ (\ ) + +如果设为 ``true``\ ，则绘制彩色字形时会应用颜色调制，否则只会对灰度字形应用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_SystemFont_property_msdf_pixel_range: .. rst-class:: classref-property @@ -331,7 +350,7 @@ SystemFont - |void| **set_oversampling**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_oversampling**\ (\ ) -字体过采样系数，如果设置为 ``0.0`` 则使用全局过采样系数。 +如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。 .. rst-class:: classref-item-separator @@ -351,6 +370,7 @@ SystemFont 字体字形的次像素定位模式。次像素定位为较小的字体提供了更清晰的文本和更好的字偶距，但会牺牲内存占用和字体栅格化速度。使用 :ref:`TextServer.SUBPIXEL_POSITIONING_AUTO` 可以根据字体大小自动启用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tabbar.rst b/classes/zh_CN/class_tabbar.rst index 5fb0c6c26a..a3fe984df7 100644 --- a/classes/zh_CN/class_tabbar.rst +++ b/classes/zh_CN/class_tabbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TabBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TabBar.xml. .. _class_TabBar: @@ -32,6 +32,8 @@ TabBar +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`clip_tabs` | ``true`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`close_with_middle_mouse` | ``true`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`int` | :ref:`current_tab` | ``-1`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`deselect_enabled` | ``false`` | @@ -158,6 +160,8 @@ TabBar +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`tab_separation` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`font_size` | | @@ -252,7 +256,7 @@ TabBar **tab_close_pressed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` -按下某个选项卡的关闭按钮时发出。 +按下某个选项卡的关闭按钮时发出，启用 :ref:`close_with_middle_mouse` 时中键点击选项卡也会发出。 \ **注意：**\ 按下关闭按钮后选项卡不会自动移除，这种行为需要手动实现。例如： @@ -420,6 +424,23 @@ enum **CloseButtonDisplayPolicy**: :ref:`🔗` **close_with_middle_mouse** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_close_with_middle_mouse**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_close_with_middle_mouse**\ (\ ) + +如果为 ``true``\ ，则鼠标中键点击会发出 :ref:`tab_close_pressed` 信号。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_property_current_tab: .. rst-class:: classref-property @@ -550,7 +571,7 @@ enum **CloseButtonDisplayPolicy**: :ref:`🔗`\ ) - :ref:`AlignmentMode` **get_tab_alignment**\ (\ ) -设置放置选项卡的位置。详见 :ref:`AlignmentMode`\ 。 +选项卡的放置位置。 .. rst-class:: classref-item-separator @@ -567,7 +588,7 @@ enum **CloseButtonDisplayPolicy**: :ref:`🔗`\ ) - :ref:`CloseButtonDisplayPolicy` **get_tab_close_display_policy**\ (\ ) -设置关闭按钮何时出现在选项卡上。有关详细信息，请参阅 :ref:`CloseButtonDisplayPolicy`\ 。 +选项卡上显示关闭按钮的时机。 .. rst-class:: classref-item-separator @@ -1115,6 +1136,18 @@ enum **CloseButtonDisplayPolicy**: :ref:`🔗` **tab_separation** = ``0`` :ref:`🔗` + +选项卡栏中选项卡的间距。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_font_font: .. rst-class:: classref-themeproperty @@ -1294,6 +1327,7 @@ enum **CloseButtonDisplayPolicy**: :ref:`🔗` | :ref:`side_margin` | ``8`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`tab_separation` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`font_size` | | @@ -425,7 +427,7 @@ enum **TabPosition**: :ref:`🔗` - |void| **set_tab_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) - :ref:`AlignmentMode` **get_tab_alignment**\ (\ ) -设置选项卡的放置位置。详见 :ref:`AlignmentMode`\ 。 +选项卡的放置位置。 .. rst-class:: classref-item-separator @@ -459,7 +461,7 @@ enum **TabPosition**: :ref:`🔗` - |void| **set_tabs_position**\ (\ value\: :ref:`TabPosition`\ ) - :ref:`TabPosition` **get_tabs_position**\ (\ ) -设置选项卡栏的位置。详见 :ref:`TabPosition`\ 。 +选项卡栏的位置。 .. rst-class:: classref-item-separator @@ -982,6 +984,18 @@ enum **TabPosition**: :ref:`🔗` ---- +.. _class_TabContainer_theme_constant_tab_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **tab_separation** = ``0`` :ref:`🔗` + +选项卡栏中选项卡的间距。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_font_font: .. rst-class:: classref-themeproperty @@ -1173,6 +1187,7 @@ enum **TabPosition**: :ref:`🔗` :ref:`TabBar` 区域的背景填充样式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tcpserver.rst b/classes/zh_CN/class_tcpserver.rst index ade8219fc8..1d60d43f34 100644 --- a/classes/zh_CN/class_tcpserver.rst +++ b/classes/zh_CN/class_tcpserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TCPServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TCPServer.xml. .. _class_TCPServer: @@ -129,6 +129,7 @@ TCP 服务器。监听端口上的连接，并在获得传入连接时返回 :re 如果连接可用，则返回带有该连接的 StreamPeerTCP。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textedit.rst b/classes/zh_CN/class_textedit.rst index 22101213db..f8013a3963 100644 --- a/classes/zh_CN/class_textedit.rst +++ b/classes/zh_CN/class_textedit.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextEdit.xml. .. _class_TextEdit: @@ -24,11 +24,19 @@ TextEdit 描述 ---- -多行文本编辑器。它还有少量用于编辑代码的功能，例如语法高亮支持。更多针对编辑代码的高阶功能见 :ref:`CodeEdit`\ 。 +多行文本编辑器，还提供了一部分用于编辑代码的工具，例如对语法高亮的支持。如果需要更高级的代码编辑工具，见 :ref:`CodeEdit`\ 。 -\ **注意：**\ 大多数视口、光标和编辑方法都包含 ``caret_index`` 参数以支持 :ref:`caret_multiple`\ 。该参数应为以下之一：\ ``-1`` 用于所有光标，\ ``0`` 用于主光标，大于 ``0`` 按照其创建顺序用于辅助光标。 +输入文本时，可以使用 Unicode、OEM、Windows Alt 代码来插入特殊字符： -\ **注意：**\ 当按住 :kbd:`Alt` 时，垂直滚轮的滚动速度将是正常速度的 5 倍。这也适用于 Godot 脚本编辑器。 +- 输入 Unicode 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （U+00E1），请按住 :kbd:`Alt` 并使用小键盘输入 :kbd:`+E1`\ （前置的零可以省略）。 + +- 输入 OEM 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （OEM 160），请按住 :kbd:`Alt` 并使用小键盘输入 ``160``\ 。 + +- 输入 Windows 码位时，请按住 :kbd:`Alt` 并通过小键盘输入码位。例如要输入字符 ``á``\ （Windows 0225）请按住 :kbd:`Alt` 并使用小键盘输入 :kbd:`0`\ 、\ :kbd:`2`\ 、\ :kbd:`2`\ 、\ :kbd:`5` 。前置的零\ **不能**\ 省略，因为 Windows 码位需要用这些零来和 OEM 码位进行区分。 + +\ **注意：**\ 大多数与视口、文本光标、编辑相关的方法都包含一个名叫 ``caret_index`` 的光标索引参数，用于支持 :ref:`caret_multiple`\ 。该参数的取值应为：\ ``-1`` 表示所有光标，\ ``0`` 表示主光标，大于 ``0`` 表示次级光标，取创建顺序。 + +\ **注意：**\ 按住 :kbd:`Alt` 时，垂直滚轮的滚动速度为原来的 5 倍。同样适用于 Godot 的脚本编辑器。 .. rst-class:: classref-reftable-group @@ -38,101 +46,107 @@ TextEdit .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``3`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_blink` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_draw_when_editable_disabled` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_move_on_right_click` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_multiple` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`CaretType` | :ref:`caret_type` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`custom_word_separators` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`drag_and_drop_selection_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`draw_spaces` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`draw_tabs` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editable` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`empty_selection_clipboard_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`highlight_all_occurrences` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`highlight_current_line` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`indent_wrapped_lines` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`language` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`minimap_draw` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`minimap_width` | ``80`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | mouse_default_cursor_shape | ``1`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`placeholder_text` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_fit_content_height` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_fit_content_width` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`scroll_horizontal` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_past_end_of_file` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_smooth` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`scroll_v_scroll_speed` | ``80.0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`scroll_vertical` | ``0.0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`selecting_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shortcut_keys_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`SyntaxHighlighter` | :ref:`syntax_highlighter` | | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`text` | ``""`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`use_custom_word_separators` | ``false`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`use_default_word_separators` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`LineWrappingMode` | :ref:`wrap_mode` | ``0`` | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``3`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`backspace_deletes_composite_character_enabled` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_blink` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_draw_when_editable_disabled` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_move_on_right_click` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_multiple` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`CaretType` | :ref:`caret_type` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_word_separators` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`drag_and_drop_selection_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_spaces` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_tabs` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editable` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`empty_selection_clipboard_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`highlight_all_occurrences` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`highlight_current_line` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`indent_wrapped_lines` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`minimap_draw` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`minimap_width` | ``80`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | mouse_default_cursor_shape | ``1`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`placeholder_text` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_fit_content_height` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_fit_content_width` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`scroll_horizontal` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_past_end_of_file` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_smooth` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scroll_v_scroll_speed` | ``80.0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scroll_vertical` | ``0.0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`selecting_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shortcut_keys_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`SyntaxHighlighter` | :ref:`syntax_highlighter` | | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tab_input_mode` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text` | ``""`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_custom_word_separators` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_default_word_separators` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_show_on_focus` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`LineWrappingMode` | :ref:`wrap_mode` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -271,12 +285,16 @@ TextEdit +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_minimap_visible_lines`\ (\ ) |const| | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_composite_character_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_next_visible_line_index_offset_from`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_next_visible_line_offset_from`\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_pos_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_previous_composite_character_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2i` | :ref:`get_rect_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_saved_version`\ (\ ) |const| | @@ -1110,7 +1128,24 @@ enum **GutterType**: :ref:`🔗` - |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) - :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) -如果 :ref:`wrap_mode` 设置为 :ref:`LINE_WRAPPING_BOUNDARY`\ ，则设置文本换行模式。不同模式的行为见 :ref:`AutowrapMode`\ 。 +如果 :ref:`wrap_mode` 设置为 :ref:`LINE_WRAPPING_BOUNDARY`\ ，则设置文本换行模式。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_property_backspace_deletes_composite_character_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **backspace_deletes_composite_character_enabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_backspace_deletes_composite_character_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_backspace_deletes_composite_character_enabled**\ (\ ) + +如果为 ``true`` 且 :ref:`caret_mid_grapheme` 为 ``false``\ ，则退格键会删除完整的组合字符，例如 ❤️‍🩹，而不是删除组合字符中的一部分。 .. rst-class:: classref-item-separator @@ -1755,6 +1790,23 @@ enum **GutterType**: :ref:`🔗` ---- +.. _class_TextEdit_property_tab_input_mode: + +.. rst-class:: classref-property + +:ref:`bool` **tab_input_mode** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tab_input_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_tab_input_mode**\ (\ ) + +如果为 ``true``\ ，则 :ref:`ProjectSettings.input/ui_text_indent` 会输入 ``Tab`` 字符，否则会让键盘焦点移至场景中的下一个 :ref:`Control`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_property_text: .. rst-class:: classref-property @@ -1834,7 +1886,24 @@ enum **GutterType**: :ref:`🔗` - |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) -如果为 ``true``\ ，则在获得焦点时会在支持的平台上显示原生虚拟键盘。 +如果为 ``true``\ ，则会在支持的平台上启用原生虚拟键盘。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_property_virtual_keyboard_show_on_focus: + +.. rst-class:: classref-property + +:ref:`bool` **virtual_keyboard_show_on_focus** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_virtual_keyboard_show_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_virtual_keyboard_show_on_focus**\ (\ ) + +如果为 ``true``\ ，则在收到获得焦点事件时会在支持的平台上显示原生虚拟键盘。 .. rst-class:: classref-item-separator @@ -2347,7 +2416,7 @@ enum **GutterType**: :ref:`🔗` :ref:`GutterType` **get_gutter_type**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` -返回给定索引处的边栏的类型。边栏可以包含图标、文本或自定义视觉效果。选项见 :ref:`GutterType`\ 。 +返回给定索引处的边栏的类型。边栏可以包含图标、文本或自定义视觉效果。 .. rst-class:: classref-item-separator @@ -2649,7 +2718,7 @@ enum **GutterType**: :ref:`🔗` menu.add_item("插入日期", MENU_MAX + 1) # 连接回调。 menu.id_pressed.connect(_on_item_pressed) - + func _on_item_pressed(id): if id == MENU_MAX + 1: insert_text_at_caret(Time.get_date_string_from_system()) @@ -2667,7 +2736,7 @@ enum **GutterType**: :ref:`🔗` // 添加事件处理器。 menu.IdPressed += OnItemPressed; } - + public void OnItemPressed(int id) { if (id == TextEdit.MenuItems.Max + 1) @@ -2708,6 +2777,20 @@ enum **GutterType**: :ref:`🔗` ---- +.. _class_TextEdit_method_get_next_composite_character_column: + +.. rst-class:: classref-method + +:ref:`int` **get_next_composite_character_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` + +如果光标位于合成字符的开头，则返回该字符末尾所在的正确列。合成字符由多个 Unicode 码位组合而成（例如修复爱心 ❤️‍🩹 的 Unicode 为 ``U+2764 U+FE0F U+200D U+1FA79``\ ）。如果文本光标位于非合成字符字素的内部，也会返回正确的列。 + +\ **注意：**\ 请使用 ``get_next_composite_character_column(get_caret_line(), get_caret_column())`` 在文本光标的位置进行检查 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_next_visible_line_index_offset_from: .. rst-class:: classref-method @@ -2746,6 +2829,20 @@ enum **GutterType**: :ref:`🔗` ---- +.. _class_TextEdit_method_get_previous_composite_character_column: + +.. rst-class:: classref-method + +:ref:`int` **get_previous_composite_character_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` + +如果光标位于合成字符的末尾，则返回该字符开头所在的正确列。合成字符由多个 Unicode 码位组合而成（例如修复爱心 ❤️‍🩹 的 Unicode 为 ``U+2764 U+FE0F U+200D U+1FA79``\ ）。如果文本光标位于非合成字符字素的内部，也会返回正确的列。 + +\ **注意：**\ 请使用 ``get_previous_composite_character_column(get_caret_line(), get_caret_column())`` 在文本光标的位置进行检查 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_rect_at_line_column: .. rst-class:: classref-method @@ -3613,7 +3710,7 @@ enum **GutterType**: :ref:`🔗` |void| **set_gutter_type**\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) :ref:`🔗` -设置给定索引处的边栏的类型。边栏可以包含图标、文本或自定义视觉效果。选项见 :ref:`GutterType`\ 。 +设置给定索引处的边栏的类型。边栏可以包含图标、文本或自定义视觉效果。 .. rst-class:: classref-item-separator @@ -4195,6 +4292,7 @@ enum **GutterType**: :ref:`🔗` 设置这个 **TextEdit** 在禁用 :ref:`editable` 时的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textline.rst b/classes/zh_CN/class_textline.rst index 0d7d181d09..7c49060039 100644 --- a/classes/zh_CN/class_textline.rst +++ b/classes/zh_CN/class_textline.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextLine.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextLine.xml. .. _class_TextLine: @@ -57,43 +57,45 @@ TextLine .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_object_rect`\ (\ key\: :ref:`Variant`\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_objects`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`float`\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`get_inferred_direction`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_object_rect`\ (\ key\: :ref:`Variant`\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_objects`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`float`\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -234,7 +236,7 @@ TextLine - |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) - :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) -设置文本超出文本行的设置宽度时的裁剪行为。有关所有模式的描述，请参阅 :ref:`OverrunBehavior`\ 。 +当文本超出设定的行宽时的裁剪行为。 .. rst-class:: classref-item-separator @@ -302,9 +304,9 @@ TextLine .. rst-class:: classref-method -|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -314,9 +316,21 @@ TextLine .. rst-class:: classref-method -|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextLine_method_get_inferred_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **get_inferred_direction**\ (\ ) |const| :ref:`🔗` + +返回由 BiDi 算法推断的文本书写方向。 .. rst-class:: classref-item-separator @@ -477,6 +491,7 @@ TextLine 将文本与给定的制表位对齐。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textmesh.rst b/classes/zh_CN/class_textmesh.rst index 46b74920e9..1ca0aa6c22 100644 --- a/classes/zh_CN/class_textmesh.rst +++ b/classes/zh_CN/class_textmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextMesh.xml. .. _class_TextMesh: @@ -12,7 +12,7 @@ TextMesh **继承：** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -从文本生成 :ref:`PrimitiveMesh`\ 。 +根据文本生成 :ref:`PrimitiveMesh`\ 。 .. rst-class:: classref-introduction-group @@ -98,7 +98,7 @@ UV 布局由 4 个横条组成，从上到下依次为：正面占 40% 高度， - |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) - :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) -如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。要了解每种模式的行为方式，请参阅 :ref:`AutowrapMode`\ 。 +如果设置为 :ref:`TextServer.AUTOWRAP_OFF` 以外的值，则文本将在节点的边界矩形内自动换行。如果你调整节点大小，就会自动更改其高度，从而显示所有文本。 .. rst-class:: classref-item-separator @@ -183,7 +183,7 @@ UV 布局由 4 个横条组成，从上到下依次为：正面占 40% 高度， - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充（即两端对齐）。请将其设置为 :ref:`HorizontalAlignment` 常量。 +控制文本的水平对齐方式。支持左对齐、居中对齐、右对齐、填充。 .. rst-class:: classref-item-separator @@ -200,7 +200,7 @@ UV 布局由 4 个横条组成，从上到下依次为：正面占 40% 高度， - |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) - |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) -行两端对齐规则。详见 :ref:`JustificationFlag`\ 。 +行填充对齐规则。 .. rst-class:: classref-item-separator @@ -372,7 +372,7 @@ UV 布局由 4 个横条组成，从上到下依次为：正面占 40% 高度， - |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) - :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) -控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐。请将其设置为 :ref:`VerticalAlignment` 常量。 +控制文本的垂直对齐方式。支持顶部对齐、居中对齐、底部对齐。 .. rst-class:: classref-item-separator @@ -392,6 +392,7 @@ UV 布局由 4 个横条组成，从上到下依次为：正面占 40% 高度， 文本宽度（单位为像素），用于填充对齐。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textparagraph.rst b/classes/zh_CN/class_textparagraph.rst index 04d3e6a2ad..17312e848e 100644 --- a/classes/zh_CN/class_textparagraph.rst +++ b/classes/zh_CN/class_textparagraph.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextParagraph.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextParagraph.xml. .. _class_TextParagraph: @@ -65,71 +65,75 @@ TextParagraph .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_dropcap`\ (\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_dropcap`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_dropcap_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_line`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_line_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_dropcap_lines`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_dropcap_rid`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_dropcap_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_line_object_rect`\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_line_objects`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_line_rid`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_line_size`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_non_wrapped_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`Vector2`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_dropcap`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_dropcap`\ (\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_dropcap_lines`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_dropcap_rid`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_dropcap_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`get_inferred_direction`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_line_object_rect`\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_line_objects`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_line_rid`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_line_size`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_non_wrapped_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_range`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`Vector2`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_dropcap`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -236,7 +240,7 @@ TextParagraph - |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) - |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) -行两端对齐规则。详见 :ref:`JustificationFlag`\ 。 +行填充对齐规则。 .. rst-class:: classref-item-separator @@ -338,7 +342,7 @@ TextParagraph - |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) - :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) -设置当文本超过段落的设置宽度时的裁剪行为。有关所有模式的描述，请参阅 :ref:`OverrunBehavior`\ 。 +当文本超出段落所设置的宽度时的裁剪行为。 .. rst-class:: classref-item-separator @@ -418,9 +422,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制文本中所有行和首字下沉，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制文本中所有行和首字下沉，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -430,9 +434,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw_dropcap**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_dropcap**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制首字下沉，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制首字下沉，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -442,9 +446,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw_dropcap_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_dropcap_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制首字下沉的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制首字下沉的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -454,9 +458,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw_line**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_line**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制一行文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制一行文本，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -466,9 +470,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw_line_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_line_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制一行文本的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制一行文本的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -478,9 +482,9 @@ TextParagraph .. rst-class:: classref-method -|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中的给定位置绘制文本中所有行和首字下沉的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。 +在画布项中的给定位置绘制文本中所有行和首字下沉的轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是边界框的左上角。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -522,6 +526,18 @@ TextParagraph ---- +.. _class_TextParagraph_method_get_inferred_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **get_inferred_direction**\ (\ ) |const| :ref:`🔗` + +返回由 BiDi 算法推断的文本书写方向。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextParagraph_method_get_line_ascent: .. rst-class:: classref-method @@ -666,6 +682,18 @@ TextParagraph ---- +.. _class_TextParagraph_method_get_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **get_range**\ (\ ) |const| :ref:`🔗` + +返回段落的字符范围。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextParagraph_method_get_rid: .. rst-class:: classref-method @@ -749,6 +777,7 @@ TextParagraph 将段落与给定的制表位对齐。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textserver.rst b/classes/zh_CN/class_textserver.rst index bb11719159..4ba20c3f2d 100644 --- a/classes/zh_CN/class_textserver.rst +++ b/classes/zh_CN/class_textserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServer.xml. .. _class_TextServer: @@ -48,443 +48,473 @@ TextServer .. table:: :widths: auto - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_font`\ (\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_shaped_text`\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FontAntialiasing` | :ref:`font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FixedSizeScaleMode` | :ref:`font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_global_oversampling`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_glyph_contours`\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Hinting` | :ref:`font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`FontStyle`\] | :ref:`font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`font_get_supported_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`, keep_rounding_remainders\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_stretch`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_style_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`format_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_features`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_support_data`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_support_data_filename`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_support_data_info`\ (\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_identifier`\ (\ string\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`load_support_data`\ (\ filename\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`name_to_tag`\ (\ name\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`percent_sign`\ (\ language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`save_support_data`\ (\ filename\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_clear`\ (\ rid\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Orientation` | :ref:`shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 4\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_has_visible_chars`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation` = 0\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`spoof_check`\ (\ string\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_diacritics`\ (\ string\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tag_to_name`\ (\ tag\: :ref:`int`\ ) |const| | - +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_font`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_shaped_text`\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_system_fallback_cache`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FontAntialiasing` | :ref:`font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_global_oversampling`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_glyph_contours`\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Hinting` | :ref:`font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`font_get_size_cache_info`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`font_get_supported_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`, keep_rounding_remainders\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_stretch`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_style_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_features`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_support_data`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_support_data_filename`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_support_data_info`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_identifier`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`load_support_data`\ (\ filename\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`name_to_tag`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`percent_sign`\ (\ language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`save_support_data`\ (\ filename\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_run_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_get_run_direction`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_get_run_font_rid`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_run_font_size`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_run_language`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_run_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_get_run_range`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_run_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_span_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_text`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_clear`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Orientation` | :ref:`shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 4\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_has_visible_chars`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`spoof_check`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_diacritics`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tag_to_name`\ (\ tag\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -525,7 +555,7 @@ enum **FontAntialiasing**: :ref:`🔗` 字体字形针对 LCD 屏幕栅格化。 -LCD 次像素布局由项目设置 ``gui/theme/lcd_subpixel_layout`` 的值决定。 +LCD 次像素布局由项目设置 :ref:`ProjectSettings.gui/theme/lcd_subpixel_layout` 的值决定。 LCD 次像素抗锯齿模式仅适用于在 2D 中渲染横向、无缩放的文本。 @@ -837,6 +867,8 @@ flags **LineBreakFlag**: :ref:`🔗` :ref:`LineBreakFlag` **BREAK_TRIM_EDGE_SPACES** = ``16`` +**已弃用：** Use ``BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES`` instead. + 移除每一行头尾的空格。 .. _class_TextServer_constant_BREAK_TRIM_INDENT: @@ -847,6 +879,26 @@ flags **LineBreakFlag**: :ref:`🔗` 从第一行之后的所有行中减去第一行的缩进宽度。 +.. _class_TextServer_constant_BREAK_TRIM_START_EDGE_SPACES: + +.. rst-class:: classref-enumeration-constant + +:ref:`LineBreakFlag` **BREAK_TRIM_START_EDGE_SPACES** = ``64`` + +自动换行后，移除行首的空格和换行字符。 + +例如将 ``test \n next`` 换行后，如果设置该标志则第二段为 ``next``\ ，如果未设置则为 `` next``\ 。 + +.. _class_TextServer_constant_BREAK_TRIM_END_EDGE_SPACES: + +.. rst-class:: classref-enumeration-constant + +:ref:`LineBreakFlag` **BREAK_TRIM_END_EDGE_SPACES** = ``128`` + +自动换行后，移除行尾的空格和换行字符。 + +例如将 ``test \n next`` 换行后，如果设置该标志则第一段为 ``test``\ ，如果未设置则为 ``test \n``\ 。 + .. rst-class:: classref-item-separator ---- @@ -939,7 +991,7 @@ enum **OverrunBehavior**: :ref:`🔗` :ref:`OverrunBehavior` **OVERRUN_TRIM_ELLIPSIS** = ``3`` -逐字符修剪文本，并通过添加省略号来表示部分文本已隐藏。 +逐字符修剪文本，如果文本修剪后至少有 6 个字符，则会通过添加省略号来表示部分文本已隐藏。 .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS: @@ -947,7 +999,23 @@ enum **OverrunBehavior**: :ref:`🔗` :ref:`OverrunBehavior` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4`` -逐单词修剪文本，并通过添加省略号来表示部分文本已隐藏。 +逐单词修剪文本，如果文本修剪后至少有 6 个字符，则会通过添加省略号来表示部分文本已隐藏。 + +.. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS_FORCE: + +.. rst-class:: classref-enumeration-constant + +:ref:`OverrunBehavior` **OVERRUN_TRIM_ELLIPSIS_FORCE** = ``5`` + +逐字符修剪文本，通过添加省略号来表示部分文本已隐藏，不考虑文本修剪后的长度。 + +.. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS_FORCE: + +.. rst-class:: classref-enumeration-constant + +:ref:`OverrunBehavior` **OVERRUN_TRIM_WORD_ELLIPSIS_FORCE** = ``6`` + +逐单词修剪文本，通过添加省略号来表示部分文本已隐藏，不考虑文本修剪后的长度。 .. rst-class:: classref-item-separator @@ -1219,7 +1287,7 @@ enum **SubpixelPositioning**: :ref:`🔗` :ref:`SubpixelPositioning` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20`` -在 :ref:`SUBPIXEL_POSITIONING_AUTO` 模式下，次像素定位时使用二分之一像素大小的最大字体大小。 +在 :ref:`SUBPIXEL_POSITIONING_AUTO` 模式下，次像素定位时使用“二分之一像素”大小的最大字体大小。 .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE: @@ -1227,7 +1295,7 @@ enum **SubpixelPositioning**: :ref:`🔗` :ref:`SubpixelPositioning` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16`` -在 :ref:`SUBPIXEL_POSITIONING_AUTO` 模式下，次像素定位时使用四分之一像素大小的最大字体大小。 +在 :ref:`SUBPIXEL_POSITIONING_AUTO` 模式下，次像素定位时使用“四分之一像素”大小的最大字体大小。 .. rst-class:: classref-item-separator @@ -1676,6 +1744,18 @@ enum **FixedSizeScaleMode**: :ref:`🔗` ---- +.. _class_TextServer_method_font_clear_system_fallback_cache: + +.. rst-class:: classref-method + +|void| **font_clear_system_fallback_cache**\ (\ ) :ref:`🔗` + +释放所有自动加载的系统字体。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_clear_textures: .. rst-class:: classref-method @@ -1694,9 +1774,9 @@ enum **FixedSizeScaleMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中某个位置绘制单个字形，使用的字体为 ``font_rid``\ ，大小为 ``size``\ 。 +在画布项中某个位置绘制单个字形，使用的字体为 ``font_rid``\ ，大小为 ``size``\ 。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 \ **注意：**\ 字形索引是特定于字体的，请使用 :ref:`shaped_text_get_glyphs()` 或 :ref:`font_get_glyph_index()` 返回的字形索引。 @@ -1710,9 +1790,9 @@ enum **FixedSizeScaleMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项中某个位置绘制单个字形轮廓，使用的字体为 ``font_rid``\ ，大小为 ``size``\ 。 +在画布项中某个位置绘制单个字形轮廓，使用的字体为 ``font_rid``\ ，大小为 ``size``\ 。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 \ **注意：**\ 字形索引是特定于字体的，请使用 :ref:`shaped_text_get_glyphs()` 或 :ref:`font_get_glyph_index()` 返回的字形索引。 @@ -1872,7 +1952,9 @@ enum **FixedSizeScaleMode**: :ref:`🔗` :ref:`float` **font_get_global_oversampling**\ (\ ) |const| :ref:`🔗` -返回字体过采样系数，由 TextServer 中的所有字体共享。 +**已弃用：** Use :ref:`Viewport` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead. + +已废弃。该方法始终返回 ``1.0``\ 。 .. rst-class:: classref-item-separator @@ -2158,7 +2240,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` :ref:`float` **font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` -返回字体过采样系数，如果设置为 ``0.0``\ ，则使用全局过采样系数。仅由动态字体使用。 +返回过采样系数覆盖值。如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。仅适用于动态字体。 .. rst-class:: classref-item-separator @@ -2200,6 +2282,18 @@ enum **FixedSizeScaleMode**: :ref:`🔗` ---- +.. _class_TextServer_method_font_get_size_cache_info: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **font_get_size_cache_info**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回字体缓存信息，每个条目都包含以下字段：\ ``Vector2i size_px`` - 字体大小，单位为像素，\ ``float viewport_oversampling`` - 视口过采样系数，\ ``int glyphs`` - 已渲染的字形数，\ ``int textures`` - 已使用的纹理数，\ ``int textures_size`` - 纹理数据大小，单位为字节。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_get_size_cache_list: .. rst-class:: classref-method @@ -2218,7 +2312,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` :ref:`int` **font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` -返回 ``spacing``\ （见 :ref:`SpacingType`\ ）的间距，单位为像素（与字体大小无关）。 +返回 ``spacing`` 的间距，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -2242,7 +2336,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` |bitfield|\[:ref:`FontStyle`\] **font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` -返回字体样式标志，见 :ref:`FontStyle`\ 。 +返回字体样式标志。 .. rst-class:: classref-item-separator @@ -2440,6 +2534,18 @@ enum **FixedSizeScaleMode**: :ref:`🔗` ---- +.. _class_TextServer_method_font_is_modulate_color_glyphs: + +.. rst-class:: classref-method + +:ref:`bool` **font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` + +如果绘制彩色字形时会应用颜色调制，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_is_multichannel_signed_distance_field: .. rst-class:: classref-method @@ -2726,9 +2832,9 @@ enum **FixedSizeScaleMode**: :ref:`🔗` |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) :ref:`🔗` -设置过采样系数，由 TextServer 中的所有字体共享。 +**已弃用：** Use :ref:`Viewport` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead. -\ **注意：**\ 显示服务器可能自动更改这个值。 +已弃用。该方法什么也不做。 .. rst-class:: classref-item-separator @@ -2844,6 +2950,18 @@ enum **FixedSizeScaleMode**: :ref:`🔗` ---- +.. _class_TextServer_method_font_set_modulate_color_glyphs: + +.. rst-class:: classref-method + +|void| **font_set_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) :ref:`🔗` + +如果设为 ``true``\ ，则绘制彩色字形时会应用颜色调制，否则只会对灰度字形应用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_set_msdf_pixel_range: .. rst-class:: classref-method @@ -2912,7 +3030,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) :ref:`🔗` -设置字体的过采样系数，如果设置为 ``0.0``\ ，则会改用全局过采样系数。仅由动态字体使用。 +如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。仅适用于动态字体。 .. rst-class:: classref-item-separator @@ -2948,7 +3066,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` |void| **font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` -将 ``spacing`` 的间距（见 :ref:`SpacingType`\ ）设置为 ``value``\ ，单位为像素（与字体大小无关）。 +将 ``spacing`` 的间距设置为 ``value``\ ，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -2974,7 +3092,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` |void| **font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) :ref:`🔗` -设置字体样式标志，见 :ref:`FontStyle`\ 。 +设置字体样式标志。 \ **注意：**\ 这个值仅用于匹配字体，不会影响字体的渲染。请改用 :ref:`font_set_face_index()`\ 、\ :ref:`font_set_variation_coordinates()`\ 、\ :ref:`font_set_embolden()` 或 :ref:`font_set_transform()`\ 。 @@ -3352,7 +3470,7 @@ enum **FixedSizeScaleMode**: :ref:`🔗` :ref:`Array`\[:ref:`Vector3i`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| :ref:`🔗` -BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`StructuredTextParser`\ 。 +BiDi 算法覆盖函数的默认实现。 .. rst-class:: classref-item-separator @@ -3384,6 +3502,102 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St ---- +.. _class_TextServer_method_shaped_get_run_count: + +.. rst-class:: classref-method + +:ref:`int` **shaped_get_run_count**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回缓冲中统一文本行程的个数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **shaped_get_run_direction**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的方向。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_font_rid: + +.. rst-class:: classref-method + +:ref:`RID` **shaped_get_run_font_rid**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的字体 RID。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_font_size: + +.. rst-class:: classref-method + +:ref:`int` **shaped_get_run_font_size**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的字体大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_language: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_run_language**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的语言。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_object: + +.. rst-class:: classref-method + +:ref:`Variant` **shaped_get_run_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的内嵌对象。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **shaped_get_run_range**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的源文本范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_run_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的源文本。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_get_span_count: .. rst-class:: classref-method @@ -3420,6 +3634,42 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St ---- +.. _class_TextServer_method_shaped_get_span_object: + +.. rst-class:: classref-method + +:ref:`Variant` **shaped_get_span_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回文本区间内嵌对象的键。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_span_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_span_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +返回文本区间的源文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_text**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` + +返回文本缓冲的源文本，包含对象替换字符。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_set_span_update_font: .. rst-class:: classref-method @@ -3484,9 +3734,11 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -|void| **shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项的给定位置绘制塑形后的文本，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。 +在画布项的给定位置绘制塑形后的文本，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 + +\ ``clip_l`` 和 ``clip_r`` 是相对于 ``pos`` 的偏移量，横向排版时朝右、纵向排版时朝下。如果 ``clip_l`` 非负数，则会裁剪在偏移量之前开始的字形。如果 ``clip_r`` 非负数，则会裁剪在偏移量之后结束的字形。 .. rst-class:: classref-item-separator @@ -3496,9 +3748,11 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -|void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` +|void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -在画布项的给定位置绘制塑形后的文本轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。 +在画布项的给定位置绘制塑形后的文本轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 + +\ ``clip_l`` 和 ``clip_r`` 是相对于 ``pos`` 的偏移量，横向排版时朝右、纵向排版时朝下。如果 ``clip_l`` 非负数，则会裁剪在偏移量之前开始的字形。如果 ``clip_r`` 非负数，则会裁剪在偏移量之后结束的字形。 .. rst-class:: classref-item-separator @@ -3924,7 +4178,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 4\ ) |const| :ref:`🔗` -将文本分解成单词并返回字符范围的数组。请使用 ``grapheme_flags`` 来设置哪些字符会被用于分解（见 :ref:`GraphemeFlag`\ ）。 +将文本分解成单词并返回字符范围的数组。请使用 ``grapheme_flags`` 来设置哪些字符会被用于分解。 .. rst-class:: classref-item-separator @@ -4281,7 +4535,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St 返回转换为标题大小写的字符串。 -\ **注意：**\ 如果服务器支持 :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` 特性（受 :ref:`TextServerAdvanced` 支持），则大小写取决于区域设置，并且对上下文敏感。 +\ **注意：**\ 如果服务器支持 :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` 特性（\ :ref:`TextServerAdvanced` 支持），则大小写取决于区域设置，并且对上下文敏感。 \ **注意：**\ 结果可能比原始结果更长或更短。 @@ -4328,6 +4582,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St 将 OpenType 标签转换为可读的特性、变体、文字、语言名称。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textserveradvanced.rst b/classes/zh_CN/class_textserveradvanced.rst index 3732035947..627d1b1e4a 100644 --- a/classes/zh_CN/class_textserveradvanced.rst +++ b/classes/zh_CN/class_textserveradvanced.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/text_server_adv/doc_classes/TextServerAdvanced.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/text_server_adv/doc_classes/TextServerAdvanced.xml. .. _class_TextServerAdvanced: @@ -22,6 +22,7 @@ TextServerAdvanced :ref:`TextServer` 的一种实现，使用 HarfBuzz、ICU 和 SIL Graphite 来支持 BiDi、复杂排版和上下文 OpenType 特性。这是 Godot 的默认主 :ref:`TextServer` 接口。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textserverdummy.rst b/classes/zh_CN/class_textserverdummy.rst index 3728b2c4b0..b84f0513ed 100644 --- a/classes/zh_CN/class_textserverdummy.rst +++ b/classes/zh_CN/class_textserverdummy.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextServerDummy.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerDummy.xml. .. _class_TextServerDummy: @@ -37,6 +37,7 @@ TextServerDummy 可以使用命令行参数 ``--text-driver Dummy``\ （大小写敏感）来强制项目使用“Dummy（虚设）”\ :ref:`TextServer`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textserverextension.rst b/classes/zh_CN/class_textserverextension.rst index d896a1e92e..7572f93007 100644 --- a/classes/zh_CN/class_textserverextension.rst +++ b/classes/zh_CN/class_textserverextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextServerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerExtension.xml. .. _class_TextServerExtension: @@ -31,449 +31,483 @@ TextServerExtension .. table:: :widths: auto - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_cleanup`\ (\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_font`\ (\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_shaped_text`\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FontAntialiasing` | :ref:`_font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FixedSizeScaleMode` | :ref:`_font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_global_oversampling`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_glyph_contours`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Hinting` | :ref:`_font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`FontStyle`\] | :ref:`_font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubpixelPositioning` | :ref:`_font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_font_get_supported_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`_font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_data_ptr`\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`, keep_rounding_remainders\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_stretch`\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_style_name`\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_format_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_features`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`_get_support_data`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_support_data_filename`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_support_data_info`\ (\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has`\ (\ rid\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_feature`\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid_identifier`\ (\ string\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_load_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_name_to_tag`\ (\ name\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`_parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_percent_sign`\ (\ language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_save_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_clear`\ (\ shaped\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`_shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``const Glyph*`` | :ref:`_shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``const Glyph*`` | :ref:`_shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`_shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`_shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Orientation` | :ref:`_shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`_shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`_shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\], skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``const Glyph*`` | :ref:`_shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_update_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_update_justification_ops`\ (\ shaped\: :ref:`RID`\ ) |virtual| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_spoof_check`\ (\ string\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_strip_diacritics`\ (\ string\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_tag_to_name`\ (\ tag\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cleanup`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_font`\ (\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_shaped_text`\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_system_fallback_cache`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FontAntialiasing` | :ref:`_font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`_font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_global_oversampling`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_glyph_contours`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Hinting` | :ref:`_font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_font_get_size_cache_info`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`_font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubpixelPositioning` | :ref:`_font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_font_get_supported_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`_font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_data_ptr`\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_keep_rounding_remainders`\ (\ font_rid\: :ref:`RID`, keep_rounding_remainders\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`, modulate\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_stretch`\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_style_name`\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_format_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_features`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_get_support_data`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_support_data_filename`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_support_data_info`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has`\ (\ rid\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_feature`\ (\ feature\: :ref:`Feature`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid_identifier`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_load_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_name_to_tag`\ (\ name\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`_parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_percent_sign`\ (\ language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reference_oversampling_level`\ (\ oversampling\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_save_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_run_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_get_run_direction`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_get_run_font_rid`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_run_font_size`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_run_language`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_run_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_get_run_range`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_run_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_span_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_text`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_clear`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Orientation` | :ref:`_shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`_shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\], skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |required| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_update_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_update_justification_ops`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_spoof_check`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_strip_diacritics`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_tag_to_name`\ (\ tag\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_unreference_oversampling_level`\ (\ oversampling\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -490,8 +524,6 @@ TextServerExtension |void| **_cleanup**\ (\ ) |virtual| :ref:`🔗` -**可选。**\ - 注销文本服务器前会调用该方法。 .. rst-class:: classref-item-separator @@ -502,9 +534,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`RID` **_create_font**\ (\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`RID` **_create_font**\ (\ ) |virtual| |required| :ref:`🔗` 新建空的字体缓存条目资源。 @@ -530,9 +560,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| |required| :ref:`🔗` 使用给定的方向 ``direction`` 和朝向 ``orientation`` 新建用于复杂排版的缓冲。 @@ -546,8 +574,6 @@ TextServerExtension |void| **_draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 绘制显示字符十六进制代码的方框。 .. rst-class:: classref-item-separator @@ -558,9 +584,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| :ref:`🔗` 从缓存条目中移除所有渲染字形信息。 @@ -574,9 +598,7 @@ TextServerExtension |void| **_font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - -移除所有字偶距覆盖项。 +移除所有字距调整覆盖。 .. rst-class:: classref-item-separator @@ -586,11 +608,21 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` +|void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` -**必选。**\ +从缓存条目中移除所有的字体大小。 -从缓存条目中移除所有字体大小。 +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__font_clear_system_fallback_cache: + +.. rst-class:: classref-method + +|void| **_font_clear_system_fallback_cache**\ (\ ) |virtual| :ref:`🔗` + +释放所有自动加载的系统字体。 .. rst-class:: classref-item-separator @@ -600,9 +632,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| :ref:`🔗` 从缓存条目中移除所有纹理。 @@ -614,11 +644,9 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` +|void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -使用大小为 ``size`` 的字体 ``font_rid`` 在画布项中的指定位置绘制单个字形。 +使用字体 ``font_rid`` 和大小 ``size`` 在画布项中的指定位置绘制单个字形。如果 ``oversampling`` 大于零，则会将其作为字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -628,11 +656,9 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` +|void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -使用大小为 ``size`` 的字体 ``font_rid`` 在画布项中的指定位置绘制单个字形轮廓，轮廓大小为 ``outline_size``\ 。 +使用字体 ``font_rid`` 和大小 ``size`` 在画布项中的指定位置绘制单个字形轮廓。如果 ``oversampling`` 大于零，则会将其作为字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -644,9 +670,7 @@ TextServerExtension :ref:`FontAntialiasing` **_font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回字体抗锯齿模式。 +返回字体的抗锯齿模式。 .. rst-class:: classref-item-separator @@ -656,11 +680,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回字体的升部（基线上方的像素数）。 +返回字体的上升幅度（超出基线的像素数）。 .. rst-class:: classref-item-separator @@ -672,8 +694,6 @@ TextServerExtension :ref:`float` **_font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回额外的基线偏移（作为字体高度的一部分）。 .. rst-class:: classref-item-separator @@ -684,9 +704,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回与 ``glyph_index`` 关联的字符代码，如果 ``glyph_index`` 无效则返回 ``0``\ 。 @@ -698,11 +716,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回字体的降部（基线下方的像素数）。 +返回字体的减少量（低于基线的像素数）。 .. rst-class:: classref-item-separator @@ -714,9 +730,7 @@ TextServerExtension :ref:`bool` **_font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回是否禁用了字体内嵌位图的加载。 +返回字体是否仅用了内嵌位图加载。 .. rst-class:: classref-item-separator @@ -728,8 +742,6 @@ TextServerExtension :ref:`float` **_font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体的加粗力度。 .. rst-class:: classref-item-separator @@ -742,8 +754,6 @@ TextServerExtension :ref:`int` **_font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 TrueType / OpenType 集合中的字体数。 .. rst-class:: classref-item-separator @@ -756,8 +766,6 @@ TextServerExtension :ref:`int` **_font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 TrueType / OpenType 集合中的活动字体索引。 .. rst-class:: classref-item-separator @@ -768,9 +776,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回位图字体的固定大小。 @@ -782,9 +788,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回位图字体的缩放模式。 @@ -798,8 +802,6 @@ TextServerExtension :ref:`bool` **_font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果启用了字体纹理 mipmap 生成，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -812,8 +814,6 @@ TextServerExtension :ref:`float` **_font_get_global_oversampling**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体过采样系数，由 TextServer 中的所有字体共享。 .. rst-class:: classref-item-separator @@ -824,9 +824,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回字形的推进量（下一个字形的偏移量）。 @@ -840,8 +838,6 @@ TextServerExtension :ref:`Dictionary` **_font_get_glyph_contours**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字形的轮廓。 .. rst-class:: classref-item-separator @@ -852,9 +848,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回 ``char`` 的字形索引，可以用 ``variation_selector`` 修改。 @@ -866,9 +860,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| |const| :ref:`🔗` 返回缓存条目中的已渲染字形列表。 @@ -880,9 +872,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回字形的基线偏移量。 @@ -894,9 +884,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回该字形的大小。 @@ -908,9 +896,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回包含该字形的缓存纹理的索引。 @@ -922,11 +908,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回包含该字形的缓冲纹理的资源 ID。 +返回包含该字形的缓存纹理的资源 ID。 .. rst-class:: classref-item-separator @@ -936,11 +920,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回包含该字形的缓冲纹理的大小。 +返回包含该字形的缓存纹理的大小。 .. rst-class:: classref-item-separator @@ -950,11 +932,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回包含该字形的缓冲纹理的矩形。 +返回包含该字形的缓存纹理中的矩形。 .. rst-class:: classref-item-separator @@ -966,8 +946,6 @@ TextServerExtension :ref:`Hinting` **_font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体微调模式。仅用于动态字体。 .. rst-class:: classref-item-separator @@ -980,8 +958,6 @@ TextServerExtension :ref:`bool` **_font_get_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字形位置的舍入行为。如果设为 ``true``\ ，在将字形对齐到像素边界时会累积余数，确保字形分布更加均匀。如果启用了次像素定位，则该设置无效。 .. rst-class:: classref-item-separator @@ -994,9 +970,7 @@ TextServerExtension :ref:`Vector2` **_font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回字形对的字偶距。 +返回字形对的字距调整。 .. rst-class:: classref-item-separator @@ -1008,9 +982,7 @@ TextServerExtension :ref:`Array`\[:ref:`Vector2i`\] **_font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回字偶距覆盖的列表。 +返回字距调整覆盖的列表。 .. rst-class:: classref-item-separator @@ -1022,8 +994,6 @@ TextServerExtension :ref:`bool` **_font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果为 ``language`` 启用了支持覆盖，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1036,8 +1006,6 @@ TextServerExtension :ref:`PackedStringArray` **_font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` -**可选。**\ - 返回语言支持覆盖的列表。 .. rst-class:: classref-item-separator @@ -1050,8 +1018,6 @@ TextServerExtension :ref:`int` **_font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回最小和最大可表示有符号距离之间形状周围范围的宽度。 .. rst-class:: classref-item-separator @@ -1064,8 +1030,6 @@ TextServerExtension :ref:`int` **_font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回用于生成 MSDF 纹理的源字体大小。 .. rst-class:: classref-item-separator @@ -1078,8 +1042,6 @@ TextServerExtension :ref:`String` **_font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体家族名称。 .. rst-class:: classref-item-separator @@ -1092,8 +1054,6 @@ TextServerExtension :ref:`Dictionary` **_font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体 OpenType 特性集覆盖。 .. rst-class:: classref-item-separator @@ -1106,8 +1066,6 @@ TextServerExtension :ref:`Dictionary` **_font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 OpenType 字体名称字符串的 :ref:`Dictionary`\ （本地化的字体名称、版本、描述、许可信息、示例文本等）。 .. rst-class:: classref-item-separator @@ -1120,9 +1078,7 @@ TextServerExtension :ref:`float` **_font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回字体过采样系数，如果设置为 ``0.0``\ ，则使用全局过采样系数。仅由动态字体使用。 +返回过采样系数覆盖值。如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。仅适用于动态字体。 .. rst-class:: classref-item-separator @@ -1132,9 +1088,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回颜色位图字体的缩放系数。 @@ -1148,8 +1102,6 @@ TextServerExtension :ref:`bool` **_font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果为 ``script`` 启用了支持覆盖，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1162,21 +1114,29 @@ TextServerExtension :ref:`PackedStringArray` **_font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` -**可选。**\ - 返回文字支持覆盖的列表。 .. rst-class:: classref-item-separator ---- +.. _class_TextServerExtension_private_method__font_get_size_cache_info: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **_font_get_size_cache_info**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +返回字体缓存信息，每个条目都包含以下字段：\ ``Vector2i size_px`` - 字体大小，单位为像素，\ ``float viewport_oversampling`` - 视口过采样系数，\ ``int glyphs`` - 已渲染的字形数，\ ``int textures`` - 已使用的纹理数，\ ``int textures_size`` - 纹理数据大小，单位为字节。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__font_get_size_cache_list: .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回缓存中字体大小的列表。每个大小都是由字体大小和轮廓大小组成的 :ref:`Vector2i`\ 。 @@ -1190,9 +1150,7 @@ TextServerExtension :ref:`int` **_font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回 ``spacing``\ （见 :ref:`SpacingType`\ ）的间距，单位为像素（与字体大小无关）。 +返回 ``spacing`` 的间距，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -1204,8 +1162,6 @@ TextServerExtension :ref:`int` **_font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回与正常宽度相比的字体拉伸量。一个介于 ``50%`` 和 ``200%`` 之间的百分比值。 .. rst-class:: classref-item-separator @@ -1218,9 +1174,7 @@ TextServerExtension |bitfield|\[:ref:`FontStyle`\] **_font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -返回字体样式标志，见 :ref:`FontStyle`\ 。 +返回字体样式标志。 .. rst-class:: classref-item-separator @@ -1232,8 +1186,6 @@ TextServerExtension :ref:`String` **_font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体样式名称。 .. rst-class:: classref-item-separator @@ -1246,8 +1198,6 @@ TextServerExtension :ref:`SubpixelPositioning` **_font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字体的次像素字形定位模式。 .. rst-class:: classref-item-separator @@ -1258,9 +1208,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回包含字体中所有可用字符的字符串。 @@ -1272,9 +1220,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`PackedInt32Array` **_font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回包含字体中所有字形索引的数组。 @@ -1286,9 +1232,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| |const| :ref:`🔗` 返回字体缓存条目所使用的纹理数。 @@ -1300,9 +1244,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回字体缓存纹理图像数据。 @@ -1316,8 +1258,6 @@ TextServerExtension :ref:`PackedInt32Array` **_font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回包含字形打包数据的数组。 .. rst-class:: classref-item-separator @@ -1330,8 +1270,6 @@ TextServerExtension :ref:`Transform2D` **_font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回应用于字体轮廓的 2D 变换。 .. rst-class:: classref-item-separator @@ -1342,9 +1280,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回基线下方下划线的像素偏移。 @@ -1356,9 +1292,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回下划线的粗细度，单位为像素。 @@ -1372,8 +1306,6 @@ TextServerExtension :ref:`Dictionary` **_font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回指定字体缓存条目的变体坐标。 .. rst-class:: classref-item-separator @@ -1386,8 +1318,6 @@ TextServerExtension :ref:`int` **_font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回该字体的字重（粗度）。一个在 ``100...999`` 范围内的值，正常字体字重为 ``400``\ ，粗体字体字重为 ``700``\ 。 .. rst-class:: classref-item-separator @@ -1398,9 +1328,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 如果该字体中包含 Unicode 字符 ``char``\ ，则返回 ``true``\ 。 @@ -1414,8 +1342,6 @@ TextServerExtension :ref:`bool` **_font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果可以自动使用系统字体作为回退字体，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1428,8 +1354,6 @@ TextServerExtension :ref:`bool` **_font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则支持自动微调，优先于字体内置微调。 .. rst-class:: classref-item-separator @@ -1442,22 +1366,30 @@ TextServerExtension :ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果该字体支持给定的语言（\ `ISO 639 `__ 代码），则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- +.. _class_TextServerExtension_private_method__font_is_modulate_color_glyphs: + +.. rst-class:: classref-method + +:ref:`bool` **_font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +如果绘制彩色字形时会应用颜色调制，则返回 ``true``\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__font_is_multichannel_signed_distance_field: .. rst-class:: classref-method :ref:`bool` **_font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果使用从动态字体矢量数据生成的单个多通道有符号距离场渲染所有大小的字形，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1470,8 +1402,6 @@ TextServerExtension :ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果字体支持给定的文字（ISO 15924 代码），则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -1482,9 +1412,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 从缓存条目中移除指定的字体大小。 @@ -1498,9 +1426,7 @@ TextServerExtension |void| **_font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` -**可选。**\ - -移除字形对的字偶距覆盖。 +移除字形对的字距调整覆盖。 .. rst-class:: classref-item-separator @@ -1512,8 +1438,6 @@ TextServerExtension |void| **_font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 移除语言支持覆盖。 .. rst-class:: classref-item-separator @@ -1526,8 +1450,6 @@ TextServerExtension |void| **_font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 移除文字支持覆盖。 .. rst-class:: classref-item-separator @@ -1538,9 +1460,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |required| :ref:`🔗` 从缓存条目中移除指定的字体大小。 @@ -1552,11 +1472,9 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| :ref:`🔗` +|void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` -**必选。**\ - -从缓存条目中移除指定的字体大小。 +从缓存条目中移除指定的纹理。 .. rst-class:: classref-item-separator @@ -1568,8 +1486,6 @@ TextServerExtension |void| **_font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 将指定的字符渲染到字体缓存纹理。 .. rst-class:: classref-item-separator @@ -1582,8 +1498,6 @@ TextServerExtension |void| **_font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 将范围内的字符渲染到字体缓存纹理。 .. rst-class:: classref-item-separator @@ -1596,8 +1510,6 @@ TextServerExtension |void| **_font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则可以自动将系统字体作为回退使用。 .. rst-class:: classref-item-separator @@ -1610,9 +1522,7 @@ TextServerExtension |void| **_font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置字体的抗锯齿模式。 +使用字体抗锯齿模式。 .. rst-class:: classref-item-separator @@ -1622,9 +1532,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置字体的升部（基线上方的像素数）。 @@ -1638,8 +1546,6 @@ TextServerExtension |void| **_font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置额外的基线偏移（作为字体高度的一部分）。 .. rst-class:: classref-item-separator @@ -1652,8 +1558,6 @@ TextServerExtension |void| **_font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体源数据，例如动态字体的源文件内容。 .. rst-class:: classref-item-separator @@ -1666,8 +1570,6 @@ TextServerExtension |void| **_font_set_data_ptr**\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体源数据指针，例如动态字体的源文件内容。 .. rst-class:: classref-item-separator @@ -1678,9 +1580,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置字体的降部（基线下方的像素数）。 @@ -1694,8 +1594,6 @@ TextServerExtension |void| **_font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则禁用内嵌字体位图的加载。 .. rst-class:: classref-item-separator @@ -1720,8 +1618,6 @@ TextServerExtension |void| **_font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 在 TrueType / OpenType 集合中设置活动字体索引。 .. rst-class:: classref-item-separator @@ -1732,9 +1628,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 设置位图字体的固定大小。如果设置为大于零的值，则会为所有字体大小使用相同的缓存条目。 @@ -1746,9 +1640,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| |required| :ref:`🔗` 设置位图字体缩放模式。仅当 ``fixed_size`` 大于零时才使用该属性。 @@ -1762,8 +1654,6 @@ TextServerExtension |void| **_font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则优先使用自动微调，而不是字体的内置微调。 .. rst-class:: classref-item-separator @@ -1776,8 +1666,6 @@ TextServerExtension |void| **_font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则启用字体纹理 mipmap 生成。 .. rst-class:: classref-item-separator @@ -1790,9 +1678,7 @@ TextServerExtension |void| **_font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置字体过采样系数，由 TextServer 中的所有字体共享。 +返回过采样系数，由 TextServer 中的所有字体共享。 .. rst-class:: classref-item-separator @@ -1802,9 +1688,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` 设置字形推进（下一个字形的偏移量）。 @@ -1816,9 +1700,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` 设置字形相对于基线的偏移量。 @@ -1830,9 +1712,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| |required| :ref:`🔗` 设置字形的大小。 @@ -1844,9 +1724,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 设置包含该字形的缓存纹理的索引。 @@ -1858,9 +1736,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| |required| :ref:`🔗` 设置包含该字形的缓存纹理中，该字形的矩形区域。 @@ -1874,8 +1750,6 @@ TextServerExtension |void| **_font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体微调模式。仅由动态字体使用。 .. rst-class:: classref-item-separator @@ -1888,8 +1762,6 @@ TextServerExtension |void| **_font_set_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID`, keep_rounding_remainders\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字形位置的舍入行为。如果设为 ``true``\ ，则会将字形与像素边界对齐时的舍入余数进行累积，确保字形分布更为均匀。启用次像素定位时该设置无效。 .. rst-class:: classref-item-separator @@ -1902,9 +1774,7 @@ TextServerExtension |void| **_font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置字形对的字偶距。 +设置字形对的字距调整。 .. rst-class:: classref-item-separator @@ -1916,22 +1786,30 @@ TextServerExtension |void| **_font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 为 :ref:`_font_is_language_supported()` 添加覆盖。 .. rst-class:: classref-item-separator ---- +.. _class_TextServerExtension_private_method__font_set_modulate_color_glyphs: + +.. rst-class:: classref-method + +|void| **_font_set_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`, modulate\: :ref:`bool`\ ) |virtual| :ref:`🔗` + +如果设为 ``true``\ ，则绘制彩色字形时会应用颜色调制，否则只会对灰度字形应用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__font_set_msdf_pixel_range: .. rst-class:: classref-method |void| **_font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置最小和最大可表示有符号距离之间形状周围范围的宽度。 .. rst-class:: classref-item-separator @@ -1944,8 +1822,6 @@ TextServerExtension |void| **_font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置用于生成 MSDF 纹理的源字体大小。 .. rst-class:: classref-item-separator @@ -1958,8 +1834,6 @@ TextServerExtension |void| **_font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则所有大小的字形都使用从动态字体向量数据生成的单个多通道带符号距离场进行渲染。MSDF 渲染能够使用任意缩放系数显示字体，字体不会变得模糊，字体大小的改变也不会消耗 CPU 的性能（因为字体不再需要在 CPU 上进行光栅化）。缺点是MSDF 无法使用字体微调。缺少字体微调时，锐度可能降低，较小的字体可能不易阅读。 .. rst-class:: classref-item-separator @@ -1972,8 +1846,6 @@ TextServerExtension |void| **_font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置该字体的家族名称。 .. rst-class:: classref-item-separator @@ -1986,8 +1858,6 @@ TextServerExtension |void| **_font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体 OpenType 特性集覆盖。 .. rst-class:: classref-item-separator @@ -2000,9 +1870,7 @@ TextServerExtension |void| **_font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置字体的过采样系数，如果设置为 ``0.0``\ ，则会改用全局过采样系数。仅由动态字体使用。 +如果设为正数，则会覆盖使用该字体的视口的过采样系数。见 :ref:`Viewport.oversampling`\ 。该值不会覆盖 ``draw_*`` 方法的 ``oversampling`` 参数。仅适用于动态字体。 .. rst-class:: classref-item-separator @@ -2012,9 +1880,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置彩色位图字体的缩放系数。 @@ -2028,8 +1894,6 @@ TextServerExtension |void| **_font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 为 :ref:`_font_is_script_supported()` 添加覆盖。 .. rst-class:: classref-item-separator @@ -2042,9 +1906,7 @@ TextServerExtension |void| **_font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - -将 ``spacing`` 的间距（见 :ref:`SpacingType`\ ）设置为 ``value``\ ，单位为像素（与字体大小无关）。 +将 ``spacing`` 的间距设置为 ``value``\ ，单位为像素（与字体大小无关）。 .. rst-class:: classref-item-separator @@ -2056,9 +1918,7 @@ TextServerExtension |void| **_font_set_stretch**\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - -返回与正常宽度相比的字体拉伸量。一个介于 ``50%`` 和 ``200%`` 之间的百分比值。 +设置与正常宽度相比的字体拉伸量，是一个在 ``50%`` 和 ``200%`` 之间的百分比值。 .. rst-class:: classref-item-separator @@ -2070,9 +1930,7 @@ TextServerExtension |void| **_font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - -返回字体样式标志，见 :ref:`FontStyle`\ 。 +设置字体的样式标志。 .. rst-class:: classref-item-separator @@ -2084,8 +1942,6 @@ TextServerExtension |void| **_font_set_style_name**\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体的样式名称。 .. rst-class:: classref-item-separator @@ -2098,8 +1954,6 @@ TextServerExtension |void| **_font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字体的次像素字形定位模式。 .. rst-class:: classref-item-separator @@ -2110,9 +1964,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| |required| :ref:`🔗` 设置字体的缓存纹理图像数据。 @@ -2126,8 +1978,6 @@ TextServerExtension |void| **_font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置包含字形打包数据的数组。 .. rst-class:: classref-item-separator @@ -2140,9 +1990,7 @@ TextServerExtension |void| **_font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置应用于字体轮廓的 2D 变换，可用于倾斜、翻转和旋转字形。 +设置应用于字体轮廓的 2D 变换，可用于倾斜、翻转、旋转字形。 .. rst-class:: classref-item-separator @@ -2152,9 +2000,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置基线下方下划线的像素偏移。 @@ -2166,9 +2012,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置下划线的粗细度，单位为像素。 @@ -2182,8 +2026,6 @@ TextServerExtension |void| **_font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` -**可选。**\ - 为指定的字体缓存条目设置变体坐标。 .. rst-class:: classref-item-separator @@ -2196,9 +2038,7 @@ TextServerExtension |void| **_font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - -设置该字体的字重（粗度）。一个在 ``100...999`` 范围内的值，正常字体字重为 ``400``\ ，粗体字体字重为 ``700``\ 。 +设置字体的字重（粗度），是一个在 ``100...999`` 范围内的值。正常字体字重为 ``400``\ ，粗体字体字重为 ``700``\ 。 .. rst-class:: classref-item-separator @@ -2210,8 +2050,6 @@ TextServerExtension :ref:`Dictionary` **_font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回支持的 OpenType 特性的字典。 .. rst-class:: classref-item-separator @@ -2224,8 +2062,6 @@ TextServerExtension :ref:`Dictionary` **_font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回支持的 OpenType 变体坐标的字典。 .. rst-class:: classref-item-separator @@ -2238,8 +2074,6 @@ TextServerExtension :ref:`String` **_format_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将数字从阿拉伯数字（0..9）转换为 ``language`` 语言的记数系统。 .. rst-class:: classref-item-separator @@ -2250,9 +2084,7 @@ TextServerExtension .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` 释放由该 :ref:`TextServer` 创建的某个对象。 @@ -2264,11 +2096,9 @@ TextServerExtension .. rst-class:: classref-method -:ref:`int` **_get_features**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_features**\ (\ ) |virtual| |required| |const| :ref:`🔗` -**必选。**\ - -返回文本服务器的功能，见 :ref:`Feature`\ 。 +返回文本服务器的特性，见 :ref:`Feature`\ 。 .. rst-class:: classref-item-separator @@ -2280,8 +2110,6 @@ TextServerExtension :ref:`Vector2` **_get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回替换字符的大小（在无效字符处绘制的带十六进制字符代码的框）。 .. rst-class:: classref-item-separator @@ -2292,9 +2120,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`String` **_get_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` 返回该服务器接口的名称。 @@ -2308,8 +2134,6 @@ TextServerExtension :ref:`PackedByteArray` **_get_support_data**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回默认的 TextServer 数据库（例如 ICU 中断迭代器和字典）。 .. rst-class:: classref-item-separator @@ -2322,8 +2146,6 @@ TextServerExtension :ref:`String` **_get_support_data_filename**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回默认的 TextServer 数据库（例如 ICU 中断迭代器和字典）文件名。 .. rst-class:: classref-item-separator @@ -2336,8 +2158,6 @@ TextServerExtension :ref:`String` **_get_support_data_info**\ (\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 TextServer 数据库（例如 ICU 中断迭代器和字典）的描述。 .. rst-class:: classref-item-separator @@ -2348,9 +2168,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` 如果 ``rid`` 是该文本服务器拥有的有效资源，则返回 ``true``\ 。 @@ -2362,9 +2180,7 @@ TextServerExtension .. rst-class:: classref-method -:ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |required| |const| :ref:`🔗` 如果服务器支持某个功能，则返回 ``true``\ 。 @@ -2378,8 +2194,6 @@ TextServerExtension :ref:`int` **_is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回 ``dict`` 中第一个与 ``string`` 在视觉上可能产生混淆的字符串的索引，如果没有找到则返回 ``-1``\ 。 .. rst-class:: classref-item-separator @@ -2392,8 +2206,6 @@ TextServerExtension :ref:`bool` **_is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**必选。**\ - 如果区域设置为从右至左，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -2406,8 +2218,6 @@ TextServerExtension :ref:`bool` **_is_valid_identifier**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果 ``string`` 是有效的标识符，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -2434,8 +2244,6 @@ TextServerExtension :ref:`bool` **_load_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 加载可选的 TextServer 数据库（例如 ICU 中断迭代器和字典）。 .. rst-class:: classref-item-separator @@ -2448,8 +2256,6 @@ TextServerExtension :ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将可读的特性、变体、文字、语言名称转换为 OpenType 标记。 .. rst-class:: classref-item-separator @@ -2462,8 +2268,6 @@ TextServerExtension :ref:`String` **_parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将数字 ``number`` 从 ``language`` 的记数系统转换为阿拉伯数字（0..9）。 .. rst-class:: classref-item-separator @@ -2476,9 +2280,7 @@ TextServerExtension :ref:`Array`\[:ref:`Vector3i`\] **_parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`StructuredTextParser`\ 。 +BiDi 算法覆盖函数的默认实现。 .. rst-class:: classref-item-separator @@ -2490,37 +2292,139 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_percent_sign**\ (\ language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回语言 ``language`` 中使用的百分比符号。 .. rst-class:: classref-item-separator ---- +.. _class_TextServerExtension_private_method__reference_oversampling_level: + +.. rst-class:: classref-method + +|void| **_reference_oversampling_level**\ (\ oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` + +将指定过采样等级的引用计数调大。该方法由 :ref:`Viewport` 调用，不应直接使用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__save_support_data: .. rst-class:: classref-method :ref:`bool` **_save_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将可选的 TextServer 数据库（例如 ICU 中断迭代器和字典）保存至文件。 .. rst-class:: classref-item-separator ---- +.. _class_TextServerExtension_private_method__shaped_get_run_count: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_get_run_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +返回缓冲中统一文本行程的个数。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **_shaped_get_run_direction**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的方向。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_font_rid: + +.. rst-class:: classref-method + +:ref:`RID` **_shaped_get_run_font_rid**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的字体 RID。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_font_size: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_get_run_font_size**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的字体大小。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_language: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_run_language**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的语言。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_object: + +.. rst-class:: classref-method + +:ref:`Variant` **_shaped_get_run_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的内嵌对象。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **_shaped_get_run_range**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的源文本范围。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_run_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +返回索引为 ``index`` 的文本行程（按显示顺序）的源文本。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__shaped_get_span_count: .. rst-class:: classref-method -:ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` -**必需。**\ - -返回使用 :ref:`_shaped_text_add_string()` 或 :ref:`_shaped_text_add_object()` 添加的文本跨度数。 +返回使用 :ref:`_shaped_text_add_string()` 或 :ref:`_shaped_text_add_object()` 添加的文本区间的数量。 .. rst-class:: classref-item-separator @@ -2530,9 +2434,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Variant` **_shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Variant` **_shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回文本内嵌对象的键。 @@ -2544,9 +2446,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Variant` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Variant` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回文本区间的元数据。 @@ -2554,15 +2454,49 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St ---- +.. _class_TextServerExtension_private_method__shaped_get_span_object: + +.. rst-class:: classref-method + +:ref:`Variant` **_shaped_get_span_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` + +返回文本区间内嵌对象的键。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_span_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_span_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` + +返回文本区间的源文本。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_text**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` + +返回文本缓冲的源文本，包含对象替换字符。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__shaped_set_span_update_font: .. rst-class:: classref-method -|void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` +|void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| |required| :ref:`🔗` -**必选。**\ - -在不更改文本的情况下，更改文本区间的字体、字体大小和 OpenType 功能。 +在不更改文本的情况下，更改文本区间的字体、字体大小和 OpenType 特性。 .. rst-class:: classref-item-separator @@ -2572,11 +2506,9 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| :ref:`🔗` +:ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` -**必需。**\ - -将内联对象添加到文本缓冲区，\ ``key`` 必须是唯一的。在文本中，对象表示为 ``length`` 个对象替换字符。 +向文本缓冲中添加内联对象，\ ``key`` 必须唯一。在文本中，对象使用 ``length`` 个对象替换字符表示。 .. rst-class:: classref-item-separator @@ -2586,9 +2518,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| |required| :ref:`🔗` 添加文本区间和字体，将其绘制到文本缓冲中。 @@ -2600,9 +2530,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -|void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -**必选。**\ +|void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` 清空文本缓冲（移除文本和内联对象）。 @@ -2616,8 +2544,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回距离 ``pos`` 最近的组合字符位置。 .. rst-class:: classref-item-separator @@ -2628,11 +2554,9 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -|void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` +|void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -在画布项的给定位置绘制塑形后的文本，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。 +在画布项的给定位置绘制塑形后的文本，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -2642,11 +2566,9 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -|void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` +|void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`, oversampling\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -在画布项的给定位置绘制塑形后的文本轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。 +在画布项的给定位置绘制塑形后的文本轮廓，颜色为 ``color``\ 。\ ``pos`` 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。如果 ``oversampling`` 大于零则会用作字体过采样系数，否则使用视口的过采样设置。 .. rst-class:: classref-item-separator @@ -2658,8 +2580,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`float` **_shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 两端对齐文本以适合指定宽度，返回新的文本宽度。 .. rst-class:: classref-item-separator @@ -2670,9 +2590,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回该文本的升部（水平排版时为基线上方的像素数，垂直排版时为基线左侧的像素数）。 @@ -2686,8 +2604,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回与文本中字符偏移 ``position`` 对应的文本光标的形状。返回的光标形状是宽度为 1 像素的矩形。 .. rst-class:: classref-item-separator @@ -2700,8 +2616,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回组合字符边界的数组。 .. rst-class:: classref-item-separator @@ -2714,8 +2628,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回文字裁剪时使用的省略字符。 .. rst-class:: classref-item-separator @@ -2728,8 +2640,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回自定义标点字符列表，用于断字。如果被设置为空字符串，则使用服务器的默认值。 .. rst-class:: classref-item-separator @@ -2740,9 +2650,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回该文本的降部（水平排版时为基线下方的像素数，垂直排版时为基线右侧的像素数）。 @@ -2756,8 +2664,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`Direction` **_shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回文本的方向。 .. rst-class:: classref-item-separator @@ -2770,8 +2676,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回文本范围内的主要书写方向。 .. rst-class:: classref-item-separator @@ -2782,9 +2686,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回省略号中的字形数。 @@ -2796,9 +2698,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回省略号中的字形数组。 @@ -2810,9 +2710,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回省略号的位置。 @@ -2824,9 +2722,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回缓冲区中的字形数。 @@ -2838,9 +2734,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回字形数组，按视觉顺序排序。 @@ -2854,8 +2748,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`Vector2` **_shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将复合字符的边界返回为距行首的偏移量。 .. rst-class:: classref-item-separator @@ -2868,8 +2760,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`Direction` **_shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回由 BiDi 算法推断的文本书写方向。 .. rst-class:: classref-item-separator @@ -2882,8 +2772,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 对文本进行断行，返回每一行的字符范围。 .. rst-class:: classref-item-separator @@ -2896,8 +2784,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 将文本拆分为行和列。返回每段的字符范围。 .. rst-class:: classref-item-separator @@ -2908,9 +2794,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| :ref:`🔗` 返回内联对象的字形索引。 @@ -2922,9 +2806,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Vector2i` **_shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Vector2i` **_shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| :ref:`🔗` 返回内联对象的字符范围。 @@ -2936,9 +2818,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |required| |const| :ref:`🔗` 返回内联对象的边界矩形。 @@ -2950,9 +2830,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回内联对象的数组。 @@ -2966,8 +2844,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`Orientation` **_shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回文本朝向。 .. rst-class:: classref-item-separator @@ -2978,9 +2854,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回子字符串源自哪个父缓冲区。 @@ -2994,8 +2868,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`bool` **_shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果文本缓冲区被配置为显示控制字符，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -3008,8 +2880,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`bool` **_shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果文本缓冲区被配置为显示十六进制代码来代替无效字符，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -3020,9 +2890,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必需。**\ +:ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回父缓冲区中子字符串缓冲区的字符范围。 @@ -3036,8 +2904,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedVector2Array` **_shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回用于指定字符范围的选区矩形。 .. rst-class:: classref-item-separator @@ -3048,9 +2914,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回该文本的大小。 @@ -3064,8 +2928,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字形或行之间添加的额外间距，单位为像素。 .. rst-class:: classref-item-separator @@ -3076,9 +2938,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回超出修剪的位置。 @@ -3090,9 +2950,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回基线下方下划线的像素偏移。 @@ -3104,9 +2962,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回下划线的粗细度。 @@ -3118,9 +2974,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 返回文本的宽度（对于水平排版）或高度（对于垂直排版）。 @@ -3134,9 +2988,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\], skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - -将文本分解成单词并返回字符范围的数组。请使用 ``grapheme_flags`` 来设置哪些字符会被用于分解（见 :ref:`GraphemeFlag`\ ）。 +将文本分解成单词并返回字符范围的数组。请使用 ``grapheme_flags`` 来设置哪些字符会被用于分解。 .. rst-class:: classref-item-separator @@ -3148,8 +3000,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回字素的索引，该字素位于基线上指定像素偏移的位置，如果没有找到，则返回 ``-1``\ 。 .. rst-class:: classref-item-separator @@ -3162,8 +3012,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回基线处指定像素偏移处的文本光标的偏移量。该函数始终返回一个有效位置。 .. rst-class:: classref-item-separator @@ -3174,9 +3022,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| |const| :ref:`🔗` 如果缓冲区成功塑形，则返回 ``true``\ 。 @@ -3190,8 +3036,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回距离 ``pos`` 最近的组合字符结束位置。 .. rst-class:: classref-item-separator @@ -3204,8 +3048,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回距离 ``pos`` 最近的字素结束位置。 .. rst-class:: classref-item-separator @@ -3218,8 +3060,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果文本超出给定宽度，则修剪文本。 .. rst-class:: classref-item-separator @@ -3232,8 +3072,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回距离 ``pos`` 最近的组合字符开始位置。 .. rst-class:: classref-item-separator @@ -3246,8 +3084,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`int` **_shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回距离 ``pos`` 最近的字素开始位置。 .. rst-class:: classref-item-separator @@ -3258,9 +3094,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| :ref:`🔗` - -**可选。**\ +:ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` 设置嵌入对象的新大小和对齐方式。 @@ -3274,8 +3108,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| :ref:`🔗` -**可选。**\ - 为结构化文本设置 BiDi 算法覆盖。 .. rst-class:: classref-item-separator @@ -3288,8 +3120,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置文字裁剪时使用的省略字符。 .. rst-class:: classref-item-separator @@ -3302,8 +3132,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置自定义标点字符列表，用于断字。如果被设置为空字符串，则使用服务器的默认值。 .. rst-class:: classref-item-separator @@ -3316,8 +3144,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置所需的文本方向。如果设置为 :ref:`TextServer.DIRECTION_AUTO`\ ，方向将根据缓冲区的内容和当前的区域设置来检测。 .. rst-class:: classref-item-separator @@ -3330,8 +3156,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置想要的文本朝向。 .. rst-class:: classref-item-separator @@ -3344,8 +3168,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则文本缓冲区将显示控制字符。 .. rst-class:: classref-item-separator @@ -3358,8 +3180,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` -**可选。**\ - 如果设置为 ``true``\ ，则文本缓冲区会将无效字符显示为十六进制代码，否则不显示任何内容。 .. rst-class:: classref-item-separator @@ -3372,8 +3192,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St |void| **_shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| :ref:`🔗` -**可选。**\ - 设置字形之间或行与行之间添加的额外像素间距。 .. rst-class:: classref-item-separator @@ -3384,9 +3202,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -**必选。**\ +:ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` 形状缓冲区（如果未塑形）。如果字符串塑形成功，则返回 ``true``\ 。 @@ -3398,9 +3214,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -**必选。**\ +``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| |required| :ref:`🔗` 按逻辑顺序返回文本字形。 @@ -3412,9 +3226,7 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St .. rst-class:: classref-method -:ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` - -**必选。**\ +:ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 返回 ``shaped`` 文本缓冲区中字符串的子字符串的文本缓冲区（包括内联对象）。 @@ -3428,8 +3240,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`float` **_shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| :ref:`🔗` -**可选。**\ - 将塑形文本与给定的制表位对齐。 .. rst-class:: classref-item-separator @@ -3442,8 +3252,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`bool` **_shaped_text_update_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` -**可选。**\ - 更新塑形文本中的断点。该方法由分词函数的默认实现调用。 .. rst-class:: classref-item-separator @@ -3456,8 +3264,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`bool` **_shaped_text_update_justification_ops**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` -**可选。**\ - 更新塑形文本中的对齐点。该方法由文本对齐函数的默认实现调用。 .. rst-class:: classref-item-separator @@ -3470,8 +3276,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`bool` **_spoof_check**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 如果 ``string`` 可能试图混淆读者，则返回 ``true``\ 。 .. rst-class:: classref-item-separator @@ -3484,8 +3288,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回组合字符边界的数组。 .. rst-class:: classref-item-separator @@ -3498,8 +3300,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`PackedInt32Array` **_string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回分词边界的数组。数组中的元素是单词起始位置和结束位置的偏移量。因此数组的长度始终为偶数。 .. rst-class:: classref-item-separator @@ -3512,8 +3312,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回将该字符串转换为小写的结果。 .. rst-class:: classref-item-separator @@ -3526,8 +3324,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回将该字符串转换为词首字母大写的结果。 .. rst-class:: classref-item-separator @@ -3540,8 +3336,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 返回将该字符串转换为大写的结果。 .. rst-class:: classref-item-separator @@ -3554,8 +3348,6 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_strip_diacritics**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ - 从字符串中剥离变音符号。 .. rst-class:: classref-item-separator @@ -3568,11 +3360,22 @@ BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 :ref:`St :ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -**可选。**\ +将 OpenType 标签转换为可读的特性、变体、文字、语言名称。 -将 OpenType 标签转换为可读的特性、变体、文字或语言的名称。 +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__unreference_oversampling_level: + +.. rst-class:: classref-method + +|void| **_unreference_oversampling_level**\ (\ oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` + +将指定过采样等级的引用计数调小，计数变零时释放过采样等级的字体缓存。该方法由 :ref:`Viewport` 调用，不应直接使用。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textserverfallback.rst b/classes/zh_CN/class_textserverfallback.rst index de9674760a..0da65c3609 100644 --- a/classes/zh_CN/class_textserverfallback.rst +++ b/classes/zh_CN/class_textserverfallback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/text_server_fb/doc_classes/TextServerFallback.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/text_server_fb/doc_classes/TextServerFallback.xml. .. _class_TextServerFallback: @@ -24,6 +24,7 @@ A fallback implementation of Godot's text server. This fallback is faster than : \ **Note:** This text server is not part of official Godot binaries. If you want to use it, compile the engine with the option ``module_text_server_fb_enabled=yes``. When building with **TextServerFallback**, consider also disabling :ref:`TextServerAdvanced` with ``module_text_server_adv_enabled=no`` to reduce binary size. .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textservermanager.rst b/classes/zh_CN/class_textservermanager.rst index 2b08e6f2fc..c8dfeea705 100644 --- a/classes/zh_CN/class_textservermanager.rst +++ b/classes/zh_CN/class_textservermanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextServerManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerManager.xml. .. _class_TextServerManager: @@ -180,6 +180,7 @@ TextServerManager 设置主 :ref:`TextServer` 接口。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture.rst b/classes/zh_CN/class_texture.rst index e749d87d84..46fdea1758 100644 --- a/classes/zh_CN/class_texture.rst +++ b/classes/zh_CN/class_texture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture.xml. .. _class_Texture: @@ -24,6 +24,7 @@ Texture **Texture** 是所有纹理类型的基类。常见的纹理类型有 :ref:`Texture2D` 和 :ref:`ImageTexture`\ 。另见 :ref:`Image`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture2d.rst b/classes/zh_CN/class_texture2d.rst index 27484d009d..4ed05cae17 100644 --- a/classes/zh_CN/class_texture2d.rst +++ b/classes/zh_CN/class_texture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2D.xml. .. _class_Texture2D: @@ -12,7 +12,7 @@ Texture2D **继承：** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**派生：** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CanvasTexture`, :ref:`CompressedTexture2D`, :ref:`CurveTexture`, :ref:`CurveXYZTexture`, :ref:`ExternalTexture`, :ref:`GradientTexture1D`, :ref:`GradientTexture2D`, :ref:`ImageTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture2D`, :ref:`PlaceholderTexture2D`, :ref:`PortableCompressedTexture2D`, :ref:`Texture2DRD`, :ref:`ViewportTexture` +**派生：** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CanvasTexture`, :ref:`CompressedTexture2D`, :ref:`CurveTexture`, :ref:`CurveXYZTexture`, :ref:`DPITexture`, :ref:`ExternalTexture`, :ref:`GradientTexture1D`, :ref:`GradientTexture2D`, :ref:`ImageTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture2D`, :ref:`PlaceholderTexture2D`, :ref:`PortableCompressedTexture2D`, :ref:`Texture2DRD`, :ref:`ViewportTexture` 用于 2D 和 3D 的纹理。 @@ -44,9 +44,9 @@ Texture2D +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_draw_rect_region`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`, clip_uv\: :ref:`bool`\ ) |virtual| |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |required| |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |required| |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_alpha`\ (\ ) |virtual| |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -126,7 +126,7 @@ Texture2D .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_height**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture2D** 的高度时调用。 @@ -138,7 +138,7 @@ Texture2D .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_width**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture2D** 的宽度时调用。 @@ -279,6 +279,7 @@ Texture2D 如果该 **Texture2D** 具有 Alpha 通道，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture2darray.rst b/classes/zh_CN/class_texture2darray.rst index 98f60540c0..19bb1fd6a7 100644 --- a/classes/zh_CN/class_texture2darray.rst +++ b/classes/zh_CN/class_texture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DArray.xml. .. _class_Texture2DArray: @@ -55,6 +55,7 @@ Texture2DArray 与 :ref:`AtlasTexture` 也不同：Texture2D 创建该资源的占位符版本（\ :ref:`PlaceholderTexture2DArray`\ ）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture2darrayrd.rst b/classes/zh_CN/class_texture2darrayrd.rst index 3cf4a6a41c..b89688d2af 100644 --- a/classes/zh_CN/class_texture2darrayrd.rst +++ b/classes/zh_CN/class_texture2darrayrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture2DArrayRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DArrayRD.xml. .. _class_Texture2DArrayRD: @@ -22,6 +22,7 @@ Texture2DArrayRD 该纹理数组类允许你使用直接在 :ref:`RenderingDevice` 上创建的 2D 数组纹理作为材质、网格等的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture2drd.rst b/classes/zh_CN/class_texture2drd.rst index 805e0f7619..9620197233 100644 --- a/classes/zh_CN/class_texture2drd.rst +++ b/classes/zh_CN/class_texture2drd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture2DRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DRD.xml. .. _class_Texture2DRD: @@ -58,6 +58,7 @@ Texture2DRD :ref:`RenderingDevice` 上创建的纹理对象的 RID。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture3d.rst b/classes/zh_CN/class_texture3d.rst index 6860483573..4ed50022b5 100644 --- a/classes/zh_CN/class_texture3d.rst +++ b/classes/zh_CN/class_texture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture3D.xml. .. _class_Texture3D: @@ -35,33 +35,33 @@ Texture3D .. table:: :widths: auto - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Image`\] | :ref:`_get_data`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_depth`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Image`\] | :ref:`get_data`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_depth`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | - +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`_get_data`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_depth`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |required| |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`get_data`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_depth`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -76,7 +76,7 @@ Texture3D .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **_get_data**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Array`\[:ref:`Image`\] **_get_data**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的数据时被调用。 @@ -88,7 +88,7 @@ Texture3D .. rst-class:: classref-method -:ref:`int` **_get_depth**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_depth**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的深度时被调用。 @@ -100,7 +100,7 @@ Texture3D .. rst-class:: classref-method -:ref:`Format` **_get_format**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Format` **_get_format**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的格式时被调用。 @@ -112,7 +112,7 @@ Texture3D .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_height**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的高度时被调用。 @@ -124,7 +124,7 @@ Texture3D .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_width**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的宽度时被调用。 @@ -136,7 +136,7 @@ Texture3D .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **Texture3D** 的 Mipmap 是否存在时被调用。 @@ -186,7 +186,7 @@ Texture3D :ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` -返回纹理当前使用的格式。详见 :ref:`Format`\ 。 +返回该纹理当前所使用的格式。 .. rst-class:: classref-item-separator @@ -225,6 +225,7 @@ Texture3D 如果该 **Texture3D** 已生成 mipmap，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texture3drd.rst b/classes/zh_CN/class_texture3drd.rst index 1c57e21dcd..436b6362c8 100644 --- a/classes/zh_CN/class_texture3drd.rst +++ b/classes/zh_CN/class_texture3drd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Texture3DRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture3DRD.xml. .. _class_Texture3DRD: @@ -56,6 +56,7 @@ Texture3DRD :ref:`RenderingDevice` 上创建的纹理对象的 RID。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturebutton.rst b/classes/zh_CN/class_texturebutton.rst index db1be9e8b8..3cf27e6b8d 100644 --- a/classes/zh_CN/class_texturebutton.rst +++ b/classes/zh_CN/class_texturebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureButton.xml. .. _class_TextureButton: @@ -309,6 +309,7 @@ enum **StretchMode**: :ref:`🔗` 鼠标在节点上按下时显示的纹理，要求节点持有键盘焦点且玩家按下了回车键或 :ref:`BaseButton.shortcut` 键。未赋值时 **TextureButton** 处于按下状态会显示 :ref:`texture_hover`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturecubemaparrayrd.rst b/classes/zh_CN/class_texturecubemaparrayrd.rst index c7c5f6e54a..9d219598ad 100644 --- a/classes/zh_CN/class_texturecubemaparrayrd.rst +++ b/classes/zh_CN/class_texturecubemaparrayrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureCubemapArrayRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureCubemapArrayRD.xml. .. _class_TextureCubemapArrayRD: @@ -22,6 +22,7 @@ TextureCubemapArrayRD 该纹理类允许你使用直接在 :ref:`RenderingDevice` 上创建的立方体贴图数组纹理作为材质、网格等的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturecubemaprd.rst b/classes/zh_CN/class_texturecubemaprd.rst index b17bbbc19f..d366441f1c 100644 --- a/classes/zh_CN/class_texturecubemaprd.rst +++ b/classes/zh_CN/class_texturecubemaprd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureCubemapRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureCubemapRD.xml. .. _class_TextureCubemapRD: @@ -22,6 +22,7 @@ TextureCubemapRD 该纹理类允许你使用直接在 :ref:`RenderingDevice` 上创建的立方体贴图纹理作为材质、网格等的纹理。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturelayered.rst b/classes/zh_CN/class_texturelayered.rst index 10387da278..c5f9cc362e 100644 --- a/classes/zh_CN/class_texturelayered.rst +++ b/classes/zh_CN/class_texturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureLayered.xml. .. _class_TextureLayered: @@ -39,35 +39,35 @@ TextureLayered .. table:: :widths: auto - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`_get_layer_data`\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_layered_type`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_layers`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_layer_data`\ (\ layer\: :ref:`int`\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LayeredType` | :ref:`get_layered_type`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layers`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`_get_layer_data`\ (\ layer_index\: :ref:`int`\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_layered_type`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_layers`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |required| |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_layer_data`\ (\ layer\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LayeredType` | :ref:`get_layered_type`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layers`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -121,7 +121,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Format` **_get_format**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`Format` **_get_format**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的格式时被调用。 @@ -133,7 +133,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_height**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的高度时被调用。 @@ -145,7 +145,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`Image` **_get_layer_data**\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` +:ref:`Image` **_get_layer_data**\ (\ layer_index\: :ref:`int`\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 中某一层的数据时被调用。 @@ -157,7 +157,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_layered_type**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_layered_type**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的层类型时被调用。 @@ -169,7 +169,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_layers**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_layers**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的层数时被调用。 @@ -181,7 +181,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`int` **_get_width**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的宽度时被调用。 @@ -193,7 +193,7 @@ enum **LayeredType**: :ref:`🔗` .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| :ref:`🔗` +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |required| |const| :ref:`🔗` 查询该 **TextureLayered** 的 Mipmap 是否存在时被调用。 @@ -207,7 +207,7 @@ enum **LayeredType**: :ref:`🔗` :ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` -返回纹理当前使用的格式。详见 :ref:`Format`\ 。 +返回该纹理当前所使用的格式。 .. rst-class:: classref-item-separator @@ -282,6 +282,7 @@ enum **LayeredType**: :ref:`🔗` 如果层生成了 mipmap 则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturelayeredrd.rst b/classes/zh_CN/class_texturelayeredrd.rst index 2c937ec7e2..adbde475b6 100644 --- a/classes/zh_CN/class_texturelayeredrd.rst +++ b/classes/zh_CN/class_texturelayeredrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureLayeredRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureLayeredRD.xml. .. _class_TextureLayeredRD: @@ -58,6 +58,7 @@ TextureLayeredRD :ref:`RenderingDevice` 上创建的纹理对象的 RID。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_textureprogressbar.rst b/classes/zh_CN/class_textureprogressbar.rst index 84b7c5f7e9..6deef64bfe 100644 --- a/classes/zh_CN/class_textureprogressbar.rst +++ b/classes/zh_CN/class_textureprogressbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureProgressBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureProgressBar.xml. .. _class_TextureProgressBar: @@ -485,6 +485,7 @@ enum **FillMode**: :ref:`🔗` 设置给定索引的拉伸边距。见 :ref:`stretch_margin_bottom` 及相关属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_texturerect.rst b/classes/zh_CN/class_texturerect.rst index 0ebbb4a599..33d198569b 100644 --- a/classes/zh_CN/class_texturerect.rst +++ b/classes/zh_CN/class_texturerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TextureRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureRect.xml. .. _class_TextureRect: @@ -201,7 +201,7 @@ enum **StretchMode**: :ref:`🔗` **实验性：** Using :ref:`EXPAND_FIT_WIDTH`, :ref:`EXPAND_FIT_WIDTH_PROPORTIONAL`, :ref:`EXPAND_FIT_HEIGHT`, or :ref:`EXPAND_FIT_HEIGHT_PROPORTIONAL` may result in unstable behavior in some :ref:`Container` controls. This behavior may be re-evaluated and changed in the future. -定义如何根据纹理的大小确定最小大小。有关选项，请参阅 :ref:`ExpandMode`\ 。 +定义如何根据纹理的大小确定最小大小。 .. rst-class:: classref-item-separator @@ -252,7 +252,7 @@ enum **StretchMode**: :ref:`🔗` - |void| **set_stretch_mode**\ (\ value\: :ref:`StretchMode`\ ) - :ref:`StretchMode` **get_stretch_mode**\ (\ ) -控件纹理在调整节点边界矩形时的行为。见 :ref:`StretchMode`\ 。 +控件纹理在调整节点边界矩形时的行为。 .. rst-class:: classref-item-separator @@ -272,6 +272,7 @@ enum **StretchMode**: :ref:`🔗` 该节点的 :ref:`Texture2D` 资源。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_theme.rst b/classes/zh_CN/class_theme.rst index abf9d84ead..59dc12ce14 100644 --- a/classes/zh_CN/class_theme.rst +++ b/classes/zh_CN/class_theme.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Theme.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Theme.xml. .. _class_Theme: @@ -167,6 +167,8 @@ Theme +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rename_theme_item`\ (\ data_type\: :ref:`DataType`, old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_type`\ (\ old_theme_type\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, color\: :ref:`Color`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, constant\: :ref:`int`\ ) | @@ -1056,6 +1058,20 @@ enum **DataType**: :ref:`🔗` ---- +.. _class_Theme_method_rename_type: + +.. rst-class:: classref-method + +|void| **rename_type**\ (\ old_theme_type\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` + +将旧的主题类型 ``old_theme_type`` 重命名为 ``theme_type``\ ，要求旧类型存在且新类型不存在。 + +\ **注意：**\ 如果将主题类型重命名为空的名称，或者是与内置类关联的类型变体，就会移除类型变体连接，且无法再单单通过重命名进行撤销。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Theme_method_set_color: .. rst-class:: classref-method @@ -1159,6 +1175,7 @@ enum **DataType**: :ref:`🔗` \ **注意：**\ 仅当该主题资源被设置为项目的默认主题时才会显示建议。参见 :ref:`ProjectSettings.gui/theme/custom`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_themedb.rst b/classes/zh_CN/class_themedb.rst index 44560d18a5..9ef8c55463 100644 --- a/classes/zh_CN/class_themedb.rst +++ b/classes/zh_CN/class_themedb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/ThemeDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ThemeDB.xml. .. _class_ThemeDB: @@ -202,6 +202,7 @@ ThemeDB 项目主题的设置请参阅 :ref:`ProjectSettings.gui/theme/custom`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_thread.rst b/classes/zh_CN/class_thread.rst index 17f2982716..8c64ebb6e6 100644 --- a/classes/zh_CN/class_thread.rst +++ b/classes/zh_CN/class_thread.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Thread.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Thread.xml. .. _class_Thread: @@ -205,6 +205,7 @@ enum **Priority**: :ref:`🔗` 要确定调用时是否不会阻塞调用线程，请检查 :ref:`is_alive()` 是否为 ``false``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tiledata.rst b/classes/zh_CN/class_tiledata.rst index ae14df9ecf..c347a190a9 100644 --- a/classes/zh_CN/class_tiledata.rst +++ b/classes/zh_CN/class_tiledata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileData.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileData.xml. .. _class_TileData: @@ -19,7 +19,7 @@ TileData 描述 ---- -**TileData** 对象代表 :ref:`TileSet` 中的单个图块，通常使用图块集编辑器进行编辑，但也可以在运行时使用 :ref:`TileMap._tile_data_runtime_update()` 进行修改。 +**TileData** 对象代表 :ref:`TileSet` 中的单个图块，通常使用图块集编辑器进行编辑，但也可以在运行时使用 :ref:`TileMapLayer._tile_data_runtime_update()` 进行修改。 .. rst-class:: classref-reftable-group @@ -334,7 +334,7 @@ TileData - |void| **set_z_index**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_index**\ (\ ) -该图块的排序索引，相对于 :ref:`TileMap`\ 。 +该图块的排序索引，相对于 :ref:`TileMapLayer`\ 。 .. rst-class:: classref-section-separator @@ -736,6 +736,7 @@ TileData 设置该图块给定 ``peering_bit`` 方向的地形位。要检查方向是否有效，请使用 :ref:`is_valid_terrain_peering_bit()`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tilemap.rst b/classes/zh_CN/class_tilemap.rst index 86334d82f0..f0946e88e2 100644 --- a/classes/zh_CN/class_tilemap.rst +++ b/classes/zh_CN/class_tilemap.rst @@ -5,8 +5,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMap.xml. .. _class_TileMap: @@ -1115,6 +1115,7 @@ Y 排序图层的 Z 索引一般应该和未 Y 排序的图层不同，否则未 \ **警告：**\ 更新 TileMap 的计算量很大，可能会影响性能。请尽量限制更新的次数和受影响的图块。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tilemaplayer.rst b/classes/zh_CN/class_tilemaplayer.rst index 59fea50a78..765c4962c0 100644 --- a/classes/zh_CN/class_tilemaplayer.rst +++ b/classes/zh_CN/class_tilemaplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileMapLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapLayer.xml. .. _class_TileMapLayer: @@ -69,6 +69,8 @@ TileMapLayer +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`occlusion_enabled` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`physics_quadrant_size` | ``16`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`rendering_quadrant_size` | ``16`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`tile_map_data` | ``PackedByteArray()`` | @@ -325,6 +327,27 @@ enum **DebugVisibilityMode**: :ref:`🔗` ---- +.. _class_TileMapLayer_property_physics_quadrant_size: + +.. rst-class:: classref-property + +:ref:`int` **physics_quadrant_size** = ``16`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_physics_quadrant_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_physics_quadrant_size**\ (\ ) + +**TileMapLayer** 的物理象限大小。物理象限中聚集的单元格具有相似的物理属性，碰撞形状会发生合并。\ :ref:`physics_quadrant_size` 定义的是形成象限的正方形的边长，使用地图坐标系。因此，默认象限大小将 ``16 * 16 = 256`` 个图块组合到了一起。 + +\ **注意：**\ 象限是根据地图坐标系创建的，“正方形”的象限在 **TileMapLayer** 的局部坐标系中可能并不是正方形。 + +\ **注意：**\ 该属性会影响 :ref:`get_coords_for_body_rid()` 的返回值。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMapLayer_property_rendering_quadrant_size: .. rst-class:: classref-property @@ -336,7 +359,7 @@ enum **DebugVisibilityMode**: :ref:`🔗` - |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_rendering_quadrant_size**\ (\ ) -**TileMapLayer** 的象限大小。象限是在单个画布项上一起绘制的一组图块，用于优化。\ :ref:`rendering_quadrant_size` 定义的是形成象限的正方形的边长，使用地图坐标系。因此，默认象限大小将 ``16 * 16 = 256`` 个图块组合到了一起。 +**TileMapLayer** 的渲染象限大小。象限是在单个画布项上一起绘制的一组图块，用于优化。\ :ref:`rendering_quadrant_size` 定义的是形成象限的正方形的边长，使用地图坐标系。因此，默认象限大小将 ``16 * 16 = 256`` 个图块组合到了一起。 象限大小不适用于 Y 排序的 **TileMapLayer**\ ，因为在这种情况下图块按 Y 位置分组。 @@ -598,7 +621,7 @@ enum **DebugVisibilityMode**: :ref:`🔗` :ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` -返回给定物理物体 :ref:`RID` 对应图块的坐标。与图块发生碰撞时，可以通过 :ref:`KinematicCollision2D.get_collider_rid()` 获取该 :ref:`RID`\ 。 +返回物理体对应物理象限的坐标（见 :ref:`physics_quadrant_size`\ ），物理体由 :ref:`RID` 指定。与图块发生碰撞时，可以通过 :ref:`KinematicCollision2D.get_collider_rid()` 获取该 :ref:`RID`\ 。 .. rst-class:: classref-item-separator @@ -885,6 +908,7 @@ enum **DebugVisibilityMode**: :ref:`🔗` \ **警告：**\ 更新 **TileMapLayer** 的计算量很大，可能会影响性能。请尽量限制更新的次数和受影响的图块。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tilemappattern.rst b/classes/zh_CN/class_tilemappattern.rst index 7dcef5f08f..c9bc30b3eb 100644 --- a/classes/zh_CN/class_tilemappattern.rst +++ b/classes/zh_CN/class_tilemappattern.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileMapPattern.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapPattern.xml. .. _class_TileMapPattern: @@ -21,7 +21,7 @@ TileMapPattern 这个资源存放的是一组单元格，能够帮助进行 :ref:`TileMap` 的批量操作。 -图案始终从 ``(0,0)`` 坐标开始，不能存在负数坐标的单元格。 +图案始终从 ``(0, 0)`` 坐标开始，不能存在负数坐标的单元格。 .. rst-class:: classref-reftable-group @@ -179,6 +179,7 @@ TileMapPattern 设置图案的大小。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tileset.rst b/classes/zh_CN/class_tileset.rst index 7a4d8e9e29..ec957dc1f0 100644 --- a/classes/zh_CN/class_tileset.rst +++ b/classes/zh_CN/class_tileset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSet.xml. .. _class_TileSet: @@ -269,7 +269,7 @@ enum **TileShape**: :ref:`🔗` 钻石图块形状（用于等轴外观）。 -\ **注意：**\ 等轴 **TileSet** 在 :ref:`TileMap` 及其所有图层都启用了Y 排序时效果最好。 +\ **注意：**\ 等轴 **TileSet** 在所有同级 :ref:`TileMapLayer` 及其派生自 :ref:`Node2D` 的父节点都启用了Y 排序时效果最好。 .. _class_TileSet_constant_TILE_SHAPE_HALF_OFFSET_SQUARE: @@ -563,7 +563,7 @@ enum **TerrainMode**: :ref:`🔗` - |void| **set_tile_layout**\ (\ value\: :ref:`TileLayout`\ ) - :ref:`TileLayout` **get_tile_layout**\ (\ ) -对于所有半偏移形状（等轴、六边形和半偏移正方形），更改图块在 TileMap 栅格中的索引方式。 +对于所有半偏移形状（等轴、六边形和半偏移正方形），更改图块在 :ref:`TileMapLayer` 栅格中的索引方式。 .. rst-class:: classref-item-separator @@ -1416,9 +1416,7 @@ enum **TerrainMode**: :ref:`🔗` 为给定的标识符创建备选级代理。代理会将一组图块标识符映射到另一组标识符。 -可以用来替换使用此 TileSet 的所有 TileMap 中的某个图块，因为 TileMap 节点将在目标图块可用时找到并使用代理的目标图块。 - -可以使用编辑器自动替换 TileMap 节点中的代理图块。 +可以使用编辑器自动替换 TileMapLayer 节点中的代理图块。 .. rst-class:: classref-item-separator @@ -1432,9 +1430,7 @@ enum **TerrainMode**: :ref:`🔗` 为给定的标识符创建坐标级代理。代理会将一组图块标识符映射到另一组标识符。使用坐标级代理时，备选图块 ID 保持不变。 -可以用来替换使用此 TileSet 的所有 TileMap 中的某个图块，因为 TileMap 节点将在目标图块可用时找到并使用代理的目标图块。 - -可以使用编辑器自动替换 TileMap 节点中的代理图块。 +可以使用编辑器自动替换 TileMapLayer 节点中的代理图块。 .. rst-class:: classref-item-separator @@ -1580,9 +1576,7 @@ enum **TerrainMode**: :ref:`🔗` 为给定的源 ID 创建源级代理。代理会将一组图块标识符映射到另一组标识符。使用源级代理时，图集坐标 ID 和备选图块 ID 均保持不变。 -可以用来替换使用此 TileSet 的所有 TileMap 中的某个源，因为 TileMap 节点将在目标源可用时找到并使用代理的目标源。 - -可以使用编辑器自动替换 TileMap 节点中的代理图块。 +可以使用编辑器自动替换 TileMapLayer 节点中的代理图块。 .. rst-class:: classref-item-separator @@ -1621,6 +1615,7 @@ enum **TerrainMode**: :ref:`🔗` 设置地形模式。每种模式决定了图块形状的哪一个位被用来匹配相邻图块的地形。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tilesetatlassource.rst b/classes/zh_CN/class_tilesetatlassource.rst index f09e6f6dd5..2bf631570b 100644 --- a/classes/zh_CN/class_tilesetatlassource.rst +++ b/classes/zh_CN/class_tilesetatlassource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileSetAtlasSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSetAtlasSource.xml. .. _class_TileSetAtlasSource: @@ -175,14 +175,14 @@ enum **TileAnimationMode**: :ref:`🔗` -代表单元格的水平翻转标志。应该直接对 :ref:`TileMap` 使用，修改放置图块的备选 ID，将其进行翻转。 +代表单元格的水平翻转标志。应该直接对 :ref:`TileMapLayer` 使用，修改放置图块的备选 ID，将其进行翻转。 :: - var alternate_id = $TileMap.get_cell_alternative_tile(0, Vector2i(2, 2)) + var alternate_id = $TileMapLayer.get_cell_alternative_tile(Vector2i(2, 2)) if not alternate_id & TileSetAtlasSource.TRANSFORM_FLIP_H: # 如果没有翻转过就进行翻转。 - $TileMap.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) + $TileMapLayer.set_cell(Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) \ **注意：**\ 可以将这些变换进行组合，从而实现 0、90、180、270 度旋转，示例如下： @@ -693,6 +693,7 @@ enum **TileAnimationMode**: :ref:`🔗` 上时，来自 **TileSetScenesCollectionSource** 的图块将自动在 TileMap 中单元格的位置上实例化相关场景。 +当放置在 :ref:`TileMapLayer` 上时，来自 **TileSetScenesCollectionSource** 的图块将自动在 TileMapLayer 中单元格的位置上实例化相关场景。 -当 :ref:`TileMap` 进入树时，场景被实例化为 :ref:`TileMap` 的子级。如果在 :ref:`TileMap` 中添加/移除已经在树内的场景图块，\ :ref:`TileMap` 将自动实例化/释放相应的场景。 +\ :ref:`TileMapLayer` 进入树后，会在帧末尾将这些场景实例化为其子节点（延迟创建）。如果在 :ref:`TileMapLayer` 中添加/移除已经在树内的场景图块，\ :ref:`TileMapLayer` 将自动实例化/释放相应的场景。 \ **注意：**\ 场景图块占用同一个图块槽，使用备用图块 ID 来标识场景索引。\ :ref:`TileSetSource.get_tiles_count()` 将始终返回 ``1``\ 。使用 :ref:`get_scene_tiles_count()` 获取 **TileSetScenesCollectionSource** 中的场景数量。 @@ -225,9 +225,10 @@ TileSetScenesCollectionSource |void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) :ref:`🔗` -将 :ref:`PackedScene` 资源分配给 ID 为 ``id`` 的场景图块。如果该场景扩展的不是 CanvasItem 则会失败，因为将场景放置到 TileMap 上需要位置属性。 +将 :ref:`PackedScene` 资源分配给 ID 为 ``id`` 的场景图块。如果该场景扩展的不是 :ref:`CanvasItem` 则会失败，因为将场景放置到 :ref:`TileMapLayer` 上需要位置属性。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tilesetsource.rst b/classes/zh_CN/class_tilesetsource.rst index 925f63cfad..d1d1b0cd9d 100644 --- a/classes/zh_CN/class_tilesetsource.rst +++ b/classes/zh_CN/class_tilesetsource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TileSetSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSetSource.xml. .. _class_TileSetSource: @@ -135,6 +135,7 @@ TileSetSource 返回该图集中是否存在坐标 ID 为 ``atlas_coords`` 的图块。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_time.rst b/classes/zh_CN/class_time.rst index bdc1179640..b8683a4b97 100644 --- a/classes/zh_CN/class_time.rst +++ b/classes/zh_CN/class_time.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Time.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Time.xml. .. _class_Time: @@ -564,6 +564,7 @@ enum **Weekday**: :ref:`🔗` \ **注意：**\ 与其他使用整数时间戳的方法不同，这个方法返回的是 :ref:`float` 类型的时间戳，可以表示比秒更高的精度。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_timer.rst b/classes/zh_CN/class_timer.rst index 707d1a0517..8fe25d1083 100644 --- a/classes/zh_CN/class_timer.rst +++ b/classes/zh_CN/class_timer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Timer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Timer.xml. .. _class_Timer: @@ -32,7 +32,7 @@ Timer \ **注意：**\ 如果只想创建一次性的计时器，不想实例化节点，请使用 :ref:`SceneTree.create_timer()`\ 。 -\ **注意：**\ 计时器会受到 :ref:`Engine.time_scale` 的影响。时间缩放值越大，计时器结束得越早。计时器的处理频率取决于帧率或 :ref:`Engine.physics_ticks_per_second`\ 。 +\ **注意：**\ 除非 :ref:`ignore_time_scale` 为 ``true``\ ，否则计时器会受到 :ref:`Engine.time_scale` 的影响。时间缩放值越大，计时器结束得越早。计时器的处理频率取决于帧率或 :ref:`Engine.physics_ticks_per_second`\ 。 .. rst-class:: classref-introduction-group @@ -204,7 +204,7 @@ enum **TimerProcessCallback**: :ref:`🔗` - |void| **set_paused**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_paused**\ (\ ) -如果为 ``true``\ ，则计时器处于暂停状态。即便调用了 :ref:`start()`\ ，处于暂停状态的计时器也不会进行处理，必须将这个属性设回 ``false`` 才会继续。 +如果为 ``true``\ ，则计时器处于暂停状态。即便调用了 :ref:`start()`\ ，处于暂停状态的计时器也不会进行处理，必须将这个属性设回 ``false`` 才会继续。另见 :ref:`stop()`\ 。 .. rst-class:: classref-item-separator @@ -221,7 +221,7 @@ enum **TimerProcessCallback**: :ref:`🔗` - |void| **set_timer_process_callback**\ (\ value\: :ref:`TimerProcessCallback`\ ) - :ref:`TimerProcessCallback` **get_timer_process_callback**\ (\ ) -指定计时器在主循环的哪个时间点进行更新（见 :ref:`TimerProcessCallback`\ ）。 +指定计时器在主循环的哪个时间点进行更新。 .. rst-class:: classref-item-separator @@ -301,9 +301,12 @@ enum **TimerProcessCallback**: :ref:`🔗` |void| **stop**\ (\ ) :ref:`🔗` -停止计时器。 +停止计时器。另见 :ref:`paused`\ 。与 :ref:`start()` 不同，计时器不在场景树中时可以安全地调用该方法。 + +\ **注意：**\ 调用 :ref:`stop()` 不会发出 :ref:`timeout` 信号，因为计时器并未超时。如果需要信号，请在调用 :ref:`stop()` 后使用 ``$Timer.timeout.emit()`` 手动发出。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tlsoptions.rst b/classes/zh_CN/class_tlsoptions.rst index 050a560ce6..6747c0b3cb 100644 --- a/classes/zh_CN/class_tlsoptions.rst +++ b/classes/zh_CN/class_tlsoptions.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TLSOptions.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TLSOptions.xml. .. _class_TLSOptions: @@ -31,7 +31,7 @@ TLSOptions 是对 :ref:`StreamPeerTLS` 和 :ref:`PacketPeer # 创建 TLS 客户端配置，使用自定义 CA 信任链。 var client_trusted_cas = load("res://my_trusted_cas.crt") var client_tls_options = TLSOptions.client(client_trusted_cas) - + # 创建 TLS 服务器配置。 var server_certs = load("res://my_server_cas.crt") var server_key = load("res://my_server_key.key") @@ -189,6 +189,7 @@ TLSOptions 是对 :ref:`StreamPeerTLS` 和 :ref:`PacketPeer \ **注意：**\ ``certificate`` 中应当包含签名 CA 的完整证书链（可以使用通用文本编辑器连接证书文件）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_torusmesh.rst b/classes/zh_CN/class_torusmesh.rst index 504970a81b..c3063936a6 100644 --- a/classes/zh_CN/class_torusmesh.rst +++ b/classes/zh_CN/class_torusmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TorusMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TorusMesh.xml. .. _class_TorusMesh: @@ -113,6 +113,7 @@ TorusMesh 构成圆环的切片数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_touchscreenbutton.rst b/classes/zh_CN/class_touchscreenbutton.rst index b162d916ab..9a80fb1734 100644 --- a/classes/zh_CN/class_touchscreenbutton.rst +++ b/classes/zh_CN/class_touchscreenbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TouchScreenButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TouchScreenButton.xml. .. _class_TouchScreenButton: @@ -283,7 +283,7 @@ enum **VisibilityMode**: :ref:`🔗` - |void| **set_visibility_mode**\ (\ value\: :ref:`VisibilityMode`\ ) - :ref:`VisibilityMode` **get_visibility_mode**\ (\ ) -按钮的可见性模式。可能的取值见 :ref:`VisibilityMode`\ 。 +按钮的可见性模式。 .. rst-class:: classref-section-separator @@ -303,6 +303,7 @@ enum **VisibilityMode**: :ref:`🔗` 如果这个按钮当前被按下，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_transform2d.rst b/classes/zh_CN/class_transform2d.rst index c2cdc4ddb3..c49e959196 100644 --- a/classes/zh_CN/class_transform2d.rst +++ b/classes/zh_CN/class_transform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Transform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Transform2D.xml. .. _class_Transform2D: @@ -433,7 +433,7 @@ Transform2D ) # 以任何方式旋转 Transform2D 都会保持其缩放。 my_transform = my_transform.rotated(TAU / 2) - + print(my_transform.get_scale()) # 输出 (2.0, 4.0) .. code-tab:: csharp @@ -445,7 +445,7 @@ Transform2D ); // R以任何方式旋转 Transform2D 都会保持其缩放。 myTransform = myTransform.Rotated(Mathf.Tau / 2.0f); - + GD.Print(myTransform.GetScale()); // 输出 (2, 4) @@ -804,6 +804,7 @@ Transform2D 通过索引访问该变换的轴（列）。索引 ``0`` 与 :ref:`x` 相同，索引 ``1`` 与 :ref:`y` 相同，索引 ``2`` 与 :ref:`origin` 相同。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_transform3d.rst b/classes/zh_CN/class_transform3d.rst index afc9e40a23..0323cfcb55 100644 --- a/classes/zh_CN/class_transform3d.rst +++ b/classes/zh_CN/class_transform3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Transform3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Transform3D.xml. .. _class_Transform3D: @@ -654,6 +654,7 @@ Transform3D \ **注意：**\ 由于浮点精度误差，请考虑改用 :ref:`is_equal_approx()`\ ，这样更可靠。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_translation.rst b/classes/zh_CN/class_translation.rst index 1d6ca67277..3be35451ff 100644 --- a/classes/zh_CN/class_translation.rst +++ b/classes/zh_CN/class_translation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Translation.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Translation.xml. .. _class_Translation: @@ -30,6 +30,8 @@ Translation - :doc:`将游戏国际化 <../tutorials/i18n/internationalizing_games>` +- :doc:`使用 gettext 进行本地化 <../tutorials/i18n/localization_using_gettext>` + - :doc:`区域设置 <../tutorials/i18n/locales>` .. rst-class:: classref-reftable-group @@ -153,6 +155,8 @@ Translation 可以使用一个额外的上下文，来指定翻译上下文或区分多义词。 +\ **注意：**\ 仅\ :doc:`基于 gettext 的翻译（PO） <../tutorials/i18n/localization_using_gettext>`\ 支持复数，CSV 不支持。 + .. rst-class:: classref-item-separator ---- @@ -215,6 +219,8 @@ Translation 数字 ``n`` 是复数对象的数目或数量。它将被用于指导翻译系统为所选语言获取正确的复数形式。 +\ **注意：**\ 仅\ :doc:`基于 gettext 的翻译（PO） <../tutorials/i18n/localization_using_gettext>`\ 支持复数，CSV 不支持。 + .. rst-class:: classref-item-separator ---- @@ -228,6 +234,7 @@ Translation 返回所有信息（翻译后的文本）。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_translationdomain.rst b/classes/zh_CN/class_translationdomain.rst index d4fa59efe7..a8188d1b3e 100644 --- a/classes/zh_CN/class_translationdomain.rst +++ b/classes/zh_CN/class_translationdomain.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TranslationDomain.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TranslationDomain.xml. .. _class_TranslationDomain: @@ -31,6 +31,8 @@ TranslationDomain .. table:: :widths: auto + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`enabled` | ``true`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_accents_enabled` | ``true`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ @@ -64,12 +66,16 @@ TranslationDomain +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale_override`\ (\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_locale_override`\ (\ locale\: :ref:`String`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, message_plural\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | @@ -84,6 +90,23 @@ TranslationDomain 属性说明 -------- +.. _class_TranslationDomain_property_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) + +如果为 ``true``\ ，则启用翻译。否则 :ref:`translate()` 和 :ref:`translate_plural()` 会返回未经修改的输入消息，忽略当前区域设置。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_property_pseudolocalization_accents_enabled: .. rst-class:: classref-property @@ -284,6 +307,18 @@ TranslationDomain ---- +.. _class_TranslationDomain_method_get_locale_override: + +.. rst-class:: classref-method + +:ref:`String` **get_locale_override**\ (\ ) |const| :ref:`🔗` + +返回翻译域的区域设置覆盖项。如果禁用区域设置覆盖则返回空字符串。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_method_get_translation_object: .. rst-class:: classref-method @@ -320,6 +355,22 @@ TranslationDomain ---- +.. _class_TranslationDomain_method_set_locale_override: + +.. rst-class:: classref-method + +|void| **set_locale_override**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` + +设置翻译域的区域设置覆盖项。 + +如果 ``locale`` 为空字符串则禁用区域设置覆盖。否则会将 ``locale`` 进行标准化，匹配已知区域设置（例如 ``en-US`` 会与 ``en_US`` 匹配）。 + +\ **注意：**\ 调用该方法不会自动更新场景树中的文本。请手动传播 :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` 信号。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_method_translate: .. rst-class:: classref-method @@ -343,6 +394,7 @@ TranslationDomain 数字 ``n`` 是复数对象的数量。翻译系统会根据这个数字来针对所选语言获取正确的复数形式。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_translationserver.rst b/classes/zh_CN/class_translationserver.rst index 61f8bfb31a..80bfc15e00 100644 --- a/classes/zh_CN/class_translationserver.rst +++ b/classes/zh_CN/class_translationserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TranslationServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TranslationServer.xml. .. _class_TranslationServer: @@ -434,6 +434,7 @@ TranslationServer \ **注意：**\ 该方法始终使用主翻译域。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tree.rst b/classes/zh_CN/class_tree.rst index e1ca2b1028..2acc1fee3c 100644 --- a/classes/zh_CN/class_tree.rst +++ b/classes/zh_CN/class_tree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Tree.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Tree.xml. .. _class_Tree: @@ -203,6 +203,8 @@ Tree +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_hovered_dimmed_color` | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_hovered_selected_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_selected_color` | ``Color(1, 1, 1, 1)`` | @@ -313,6 +315,10 @@ Tree +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`hovered_dimmed` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected_focus` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`selected` | | @@ -437,7 +443,9 @@ Tree **item_collapsed**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` -点击折叠箭头折叠某一项时发出。 +Emitted when an item is expanded or collapsed by clicking on the folding arrow or through code. + +\ **Note:** Despite its name, this signal is also emitted when an item is expanded. .. rst-class:: classref-item-separator @@ -1044,7 +1052,7 @@ enum **DropModeFlags**: :ref:`🔗` func _ready(): $Tree.item_edited.connect(on_Tree_item_edited) - + func on_Tree_item_edited(): print($Tree.get_edited()) # 该项刚刚被编辑（例如被勾选）。 @@ -1054,7 +1062,7 @@ enum **DropModeFlags**: :ref:`🔗` { GetNode("Tree").ItemEdited += OnTreeItemEdited; } - + public void OnTreeItemEdited() { GD.Print(GetNode("Tree").GetEdited()); // 该项刚刚被编辑（例如被勾选）。 @@ -1399,7 +1407,7 @@ enum **DropModeFlags**: :ref:`🔗` :ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` -项目处于悬停状态时使用的文本颜色 :ref:`Color`\ 。 +项目处于悬停但未选中状态时使用的文本 :ref:`Color`\ 。 .. rst-class:: classref-item-separator @@ -1417,6 +1425,18 @@ enum **DropModeFlags**: :ref:`🔗` ---- +.. _class_Tree_theme_color_font_hovered_selected_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hovered_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +项目处于悬停且已选中状态时使用的文本 :ref:`Color`\ 。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_color_font_outline_color: .. rst-class:: classref-themeproperty @@ -2061,7 +2081,7 @@ enum **DropModeFlags**: :ref:`🔗` :ref:`StyleBox` **hovered** :ref:`🔗` -项目处于悬停状态时使用的 :ref:`StyleBox`\ 。 +项目处于悬停但未选中状态时的 :ref:`StyleBox`\ 。 .. rst-class:: classref-item-separator @@ -2079,6 +2099,30 @@ enum **DropModeFlags**: :ref:`🔗` ---- +.. _class_Tree_theme_style_hovered_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hovered_selected** :ref:`🔗` + +项目处于悬停且选中状态时的 :ref:`StyleBox`\ ，在 **Tree** 未获得焦点时使用。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_style_hovered_selected_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hovered_selected_focus** :ref:`🔗` + +项目处于悬停且选中状态时的 :ref:`StyleBox`\ ，在 **Tree** 获得焦点时使用。 + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_style_panel: .. rst-class:: classref-themeproperty @@ -2148,6 +2192,7 @@ enum **DropModeFlags**: :ref:`🔗` 当标题按钮被按下时使用的 :ref:`StyleBox`\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_treeitem.rst b/classes/zh_CN/class_treeitem.rst index 310f6bfd40..cc402572c6 100644 --- a/classes/zh_CN/class_treeitem.rst +++ b/classes/zh_CN/class_treeitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TreeItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TreeItem.xml. .. _class_TreeItem: @@ -51,223 +51,229 @@ TreeItem .. table:: :widths: auto - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_buttons`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_child_count`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_index`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`uncollapse_tree`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", description\: :ref:`String` = ""\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_buttons`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_child_count`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_description`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_index`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_description`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_description`\ (\ column\: :ref:`int`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`uncollapse_tree`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -416,9 +422,9 @@ enum **TreeCellMode**: :ref:`🔗` .. rst-class:: classref-method -|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) :ref:`🔗` +|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", description\: :ref:`String` = ""\ ) :ref:`🔗` -在 ``column`` 列的末尾添加一个带有 :ref:`Texture` ``button`` 的按钮。\ ``id`` 用于标识按钮。如果未指定，则使用下一个可用索引，可以在此方法之前调用 :ref:`get_button_count()` 来获取该索引。另外，该按钮还可以通过 ``disabled`` 禁用、通过 ``tooltip_text`` 设置工具提示。 +在 ``column`` 列的末尾添加一个带有 :ref:`Texture2D` ``button`` 的按钮。\ ``id`` 用于在 :ref:`Tree.button_clicked` 信号中标识按钮，可以与按钮索引不同。如果未指定，则使用下一个可用索引，可以在此方法之前调用 :ref:`get_button_count()` 来获取该索引。另外，该按钮还可以通过 ``disabled`` 禁用、通过 ``tooltip_text`` 设置工具提示。\ ``description`` 是辅助应用的按钮描述。 .. rst-class:: classref-item-separator @@ -728,6 +734,18 @@ enum **TreeCellMode**: :ref:`🔗` ---- +.. _class_TreeItem_method_get_description: + +.. rst-class:: classref-method + +:ref:`String` **get_description**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` + +返回给定列为辅助应用提供的描述。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_get_expand_right: .. rst-class:: classref-method @@ -1310,6 +1328,18 @@ enum **TreeCellMode**: :ref:`🔗` ---- +.. _class_TreeItem_method_set_button_description: + +.. rst-class:: classref-method + +|void| **set_button_description**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, description\: :ref:`String`\ ) :ref:`🔗` + +设置给定列中索引为 ``button_index`` 的按钮为辅助应用提供的描述。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_button_disabled: .. rst-class:: classref-method @@ -1340,7 +1370,7 @@ enum **TreeCellMode**: :ref:`🔗` |void| **set_cell_mode**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) :ref:`🔗` -将给定列的单元格模式设置为 ``mode``\ 。决定了单元格的显示和编辑方式。见 :ref:`TreeCellMode` 常量。 +将给定列的单元格模式设置为 ``mode``\ 。决定了单元格的显示和编辑方式。 .. rst-class:: classref-item-separator @@ -1460,6 +1490,18 @@ enum **TreeCellMode**: :ref:`🔗` ---- +.. _class_TreeItem_method_set_description: + +.. rst-class:: classref-method + +|void| **set_description**\ (\ column\: :ref:`int`, description\: :ref:`String`\ ) :ref:`🔗` + +设置给定列为辅助应用提供的描述。 + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_edit_multiline: .. rst-class:: classref-method @@ -1688,7 +1730,7 @@ enum **TreeCellMode**: :ref:`🔗` |void| **set_text_alignment**\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` -设置给定列的文本对齐方式。可能的值见 :ref:`HorizontalAlignment`\ 。 +将给定列的文本对齐方式设置为 ``text_alignment``\ 。 .. rst-class:: classref-item-separator @@ -1739,6 +1781,7 @@ enum **TreeCellMode**: :ref:`🔗` 展开显示该 **TreeItem** 所需的所有 **TreeItem**\ ，即所有祖先 **TreeItem**\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_trianglemesh.rst b/classes/zh_CN/class_trianglemesh.rst index 4851ca948f..1668b18986 100644 --- a/classes/zh_CN/class_trianglemesh.rst +++ b/classes/zh_CN/class_trianglemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TriangleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TriangleMesh.xml. .. _class_TriangleMesh: @@ -12,16 +12,120 @@ TriangleMesh **继承：** :ref:`RefCounted` **<** :ref:`Object` -内部网格类型。 +用于高效、无物理交互查询的三角形几何体。 .. rst-class:: classref-introduction-group 描述 ---- -内部用于碰撞计算的网格类型。 +在三角形几何体周围创建一个包围体积层次（Bounding Volume Hierarchy，BVH）树结构。 + +三角形 BVH 树可以用于高效的交互查询，无需涉及物理引擎。 + +例如，在编辑器工具中可以用来根据鼠标光标位置选择具有复杂形状的对象。 + +\ **性能：**\ 为复杂几何体创建 BVH 树是一个缓慢的过程，最好在后台线程中进行。 + +.. rst-class:: classref-reftable-group + +方法 +---- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`create_from_faces`\ (\ faces\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray`\ (\ begin\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_segment`\ (\ begin\: :ref:`Vector3`, end\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +方法说明 +-------- + +.. _class_TriangleMesh_method_create_from_faces: + +.. rst-class:: classref-method + +:ref:`bool` **create_from_faces**\ (\ faces\: :ref:`PackedVector3Array`\ ) :ref:`🔗` + +根据面数组创建 BVH 树。输入的 ``faces`` 数组中的每三个顶点代表一个三角形（面）。 + +如果树成功构建则返回 ``true``\ ，否则返回 ``false``\ 。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_get_faces: + +.. rst-class:: classref-method + +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| :ref:`🔗` + +返回几何体中所有面的副本。数组中每三个顶点代表一个三角形（面）。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_intersect_ray: + +.. rst-class:: classref-method + +:ref:`Dictionary` **intersect_ray**\ (\ begin\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +检测与射线的交点，射线从 ``begin`` 开始，朝向 ``dir``\ ，无限延伸。 + +如果与某个三角形存在交点，则返回一个 :ref:`Dictionary`\ ，其中包含以下字段： + +\ ``position``\ ：相交三角形上的位置。 + +\ ``normal``\ ：相交三角形的法线。 + +\ ``face_index``\ ：相交三角形的索引。 + +如果不存在交点则返回空 :ref:`Dictionary`\ 。 + +另见 :ref:`intersect_segment()`\ ，与此方法类似，但使用的是线段，长度有限。 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_intersect_segment: + +.. rst-class:: classref-method + +:ref:`Dictionary` **intersect_segment**\ (\ begin\: :ref:`Vector3`, end\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +检测与线段的交点，线段从 ``begin`` 开始，到 ``end`` 结束。 + +如果与某个三角形存在交点，则返回一个 :ref:`Dictionary`\ ，其中包含以下字段： + +\ ``position``\ ：相交三角形上的位置。 + +\ ``normal``\ ：相交三角形的法线。 + +\ ``face_index``\ ：相交三角形的索引。 + +如果不存在交点则返回空 :ref:`Dictionary`\ 。 + +另见 :ref:`intersect_ray()`\ ，与此方法类似，但使用的是射线，长度无限。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tubetrailmesh.rst b/classes/zh_CN/class_tubetrailmesh.rst index 5e3ed2dbda..9a5a4b922c 100644 --- a/classes/zh_CN/class_tubetrailmesh.rst +++ b/classes/zh_CN/class_tubetrailmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/TubeTrailMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TubeTrailMesh.xml. .. _class_TubeTrailMesh: @@ -200,6 +200,7 @@ TubeTrailMesh 管身分区总数。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` diff --git a/classes/zh_CN/class_tween.rst b/classes/zh_CN/class_tween.rst index 434486979a..09bef49d2d 100644 --- a/classes/zh_CN/class_tween.rst +++ b/classes/zh_CN/class_tween.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/Tween.xml. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Tween.xml. .. _class_Tween: @@ -33,8 +33,8 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ .. code-tab:: gdscript var tween = get_tree().create_tween() - tween.tween_property($Sprite, "modulate", Color.RED, 1) - tween.tween_property($Sprite, "scale", Vector2(), 1) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0) + tween.tween_property($Sprite, "scale", Vector2(), 1.) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -56,8 +56,8 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ .. code-tab:: gdscript var tween = get_tree().create_tween() - tween.tween_property($Sprite, "modulate", Color.RED, 1).set_trans(Tween.TRANS_SINE) - tween.tween_property($Sprite, "scale", Vector2(), 1).set_trans(Tween.TRANS_BOUNCE) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0).set_trans(Tween.TRANS_SINE) + tween.tween_property($Sprite, "scale", Vector2(), 1.0).set_trans(Tween.TRANS_BOUNCE) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -77,8 +77,8 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ .. code-tab:: gdscript var tween = get_tree().create_tween().bind_node(self).set_trans(Tween.TRANS_ELASTIC) - tween.tween_property($Sprite, "modulate", Color.RED, 1) - tween.tween_property($Sprite, "scale", Vector2(), 1) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0) + tween.tween_property($Sprite, "scale", Vector2(), 1.0) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -99,7 +99,7 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ var tween = create_tween() for sprite in get_children(): - tween.tween_property(sprite, "position", Vector2(0, 0), 1) + tween.tween_property(sprite, "position", Vector2(0, 0), 1.0) .. code-tab:: csharp @@ -109,7 +109,7 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ -在上面的示例中，一个节点的所有子节点都被依次移动到位置 (0, 0)。 +在上面的示例中，一个节点的所有子节点都被依次移动到位置 ``(0, 0)``\ 。 应该避免为对象的同一属性使用多个 **Tween**\ 。如果两个或多个补间同时为同一个属性设置动画，则最后创建的补间将优先使用，并分配最终值。如果要中断并重新启动动画，请考虑将 **Tween** 赋给变量： @@ -127,7 +127,7 @@ Tween 主要用于需要将一个数值属性插值到一系列值的动画。\ .. code-tab:: csharp private Tween _tween; - + public void Animate() { if (_tween != null) @@ -749,7 +749,7 @@ enum **EaseType**: :ref:`🔗` :ref:`Tween` **set_pause_mode**\ (\ mode\: :ref:`TweenPauseMode`\ ) :ref:`🔗` -决定该 **Tween** 在 :ref:`SceneTree` 暂停时的行为。可选项请查看 :ref:`TweenPauseMode`\ 。 +决定该 **Tween** 在 :ref:`SceneTree` 暂停时的行为。 默认值为 :ref:`TWEEN_PAUSE_BOUND`\ 。 @@ -817,14 +817,14 @@ enum **EaseType**: :ref:`🔗` :: var tween = create_tween() - + # 将在 1 秒内从 0 移动到 500。 position.x = 0.0 tween.tween_property(self, "position:x", 500, 1.0) - + # 计时器结束时（大概）在 250。 await get_tree().create_timer(0.5).timeout - + # 现在将在 1 秒内从（大概）250 移动到 500， # 因此速度为原先的一半。 tween.stop() @@ -852,7 +852,7 @@ enum **EaseType**: :ref:`🔗` .. code-tab:: gdscript var tween = get_tree().create_tween().set_loops() - tween.tween_callback(shoot).set_delay(1) + tween.tween_callback(shoot).set_delay(1.0) .. code-tab:: csharp @@ -920,10 +920,10 @@ enum **EaseType**: :ref:`🔗` .. code-tab:: gdscript var tween = create_tween().set_loops() - tween.tween_property($Sprite, "position:x", 200.0, 1).as_relative() + tween.tween_property($Sprite, "position:x", 200.0, 1.0).as_relative() tween.tween_callback(jump) tween.tween_interval(2) - tween.tween_property($Sprite, "position:x", -200.0, 1).as_relative() + tween.tween_property($Sprite, "position:x", -200.0, 1.0).as_relative() tween.tween_callback(jump) tween.tween_interval(2) @@ -959,7 +959,7 @@ enum **EaseType**: :ref:`🔗` .. code-tab:: gdscript var tween = create_tween() - tween.tween_method(look_at.bind(Vector3.UP), Vector3(-1, 0, -1), Vector3(1, 0, -1), 1) # look_at() 方法的第二个参数接受的是上向量。 + tween.tween_method(look_at.bind(Vector3.UP), Vector3(-1, 0, -1), Vector3(1, 0, -1), 1.0) # look_at() 方法的第二个参数接受的是上向量。 .. code-tab:: csharp @@ -978,7 +978,7 @@ enum **EaseType**: :ref:`🔗` func _ready(): var tween = create_tween() tween.tween_method(set_label_text, 0, 10, 1).set_delay(1) - + func set_label_text(value: int): $Label.text = "Counting " + str(value) @@ -987,11 +987,11 @@ enum **EaseType**: :ref:`🔗` public override void _Ready() { base._Ready(); - + Tween tween = CreateTween(); tween.TweenMethod(Callable.From(SetLabelText), 0.0f, 10.0f, 1.0f).SetDelay(1.0f); } - + private void SetLabelText(int value) { GetNode