TextServerExtension

继承： TextServer < RefCounted < Object

派生： TextServerAdvanced, TextServerDummy, TextServerFallback

自定义 TextServer 实现（插件）的基类。

描述

外部的 TextServer 实现应该继承这个类。

方法

方法说明

void _cleanup() virtual 🔗

可选。

注销文本服务器前会调用该方法。

RID _create_font() virtual 🔗

必选。

新建空的字体缓存条目资源。

RID _create_font_linked_variation(font_rid: RID) virtual 🔗

可选，如果字体支持额外间距或基线偏移，则实现该方法。

创建一个新的已有字体变体，该字体重复使用相同的字形缓存和字体数据。

RID _create_shaped_text(direction: Direction, orientation: Orientation) virtual 🔗

必选。

使用给定的方向 direction 和朝向 orientation 新建用于复杂排版的缓冲。

void _draw_hex_code_box(canvas: RID, size: int, pos: Vector2, index: int, color: Color) virtual const 🔗

可选。

绘制显示字符十六进制代码的方框。

void _font_clear_glyphs(font_rid: RID, size: Vector2i) virtual 🔗

必选。

从缓存条目中移除所有渲染字形信息。

void _font_clear_kerning_map(font_rid: RID, size: int) virtual 🔗

可选。

移除所有字偶距覆盖项。

void _font_clear_size_cache(font_rid: RID) virtual 🔗

必选。

从缓存条目中移除所有字体大小。

void _font_clear_textures(font_rid: RID, size: Vector2i) virtual 🔗

必选。

从缓存条目中移除所有纹理。

void _font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color) virtual const 🔗

必选。

使用大小为 size 的字体 font_rid 在画布项中的指定位置绘制单个字形。

void _font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color) virtual const 🔗

必选。

使用大小为 size 的字体 font_rid 在画布项中的指定位置绘制单个字形轮廓，轮廓大小为 outline_size。

FontAntialiasing _font_get_antialiasing(font_rid: RID) virtual const 🔗

可选。

返回字体抗锯齿模式。

float _font_get_ascent(font_rid: RID, size: int) virtual const 🔗

必选。

返回字体的升部（基线上方的像素数）。

float _font_get_baseline_offset(font_rid: RID) virtual const 🔗

可选。

返回额外的基线偏移（作为字体高度的一部分）。

int _font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) virtual const 🔗

必选。

返回与 glyph_index 关联的字符代码，如果 glyph_index 无效则返回 0。

float _font_get_descent(font_rid: RID, size: int) virtual const 🔗

必选。

返回字体的降部（基线下方的像素数）。

bool _font_get_disable_embedded_bitmaps(font_rid: RID) virtual const 🔗

可选。

返回是否禁用了字体内嵌位图的加载。

float _font_get_embolden(font_rid: RID) virtual const 🔗

可选。

返回字体的加粗力度。

int _font_get_face_count(font_rid: RID) virtual const 🔗

可选。

返回 TrueType / OpenType 集合中的字体数。

int _font_get_face_index(font_rid: RID) virtual const 🔗

可选。

返回 TrueType / OpenType 集合中的活动字体索引。

int _font_get_fixed_size(font_rid: RID) virtual const 🔗

必选。

返回位图字体的固定大小。

FixedSizeScaleMode _font_get_fixed_size_scale_mode(font_rid: RID) virtual const 🔗

必选。

返回位图字体的缩放模式。

bool _font_get_generate_mipmaps(font_rid: RID) virtual const 🔗

可选。

如果启用了字体纹理 mipmap 生成，则返回 true。

float _font_get_global_oversampling() virtual const 🔗

可选。

返回字体过采样系数，由 TextServer 中的所有字体共享。

Vector2 _font_get_glyph_advance(font_rid: RID, size: int, glyph: int) virtual const 🔗

必选。

返回字形的推进量（下一个字形的偏移量）。

Dictionary _font_get_glyph_contours(font_rid: RID, size: int, index: int) virtual const 🔗

可选。

返回字形的轮廓。

int _font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) virtual const 🔗

必选。

返回 char 的字形索引，可以用 variation_selector 修改。

PackedInt32Array _font_get_glyph_list(font_rid: RID, size: Vector2i) virtual const 🔗

必选。

返回缓存条目中的已渲染字形列表。

Vector2 _font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回字形的基线偏移量。

Vector2 _font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回该字形的大小。

int _font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回包含该字形的缓存纹理的索引。

RID _font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回包含该字形的缓冲纹理的资源 ID。

Vector2 _font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回包含该字形的缓冲纹理的大小。

Rect2 _font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) virtual const 🔗

必选。

返回包含该字形的缓冲纹理的矩形。

Hinting _font_get_hinting(font_rid: RID) virtual const 🔗

可选。

返回字体微调模式。仅用于动态字体。

Vector2 _font_get_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual const 🔗

可选。

返回字形对的字偶距。

Array[Vector2i] _font_get_kerning_list(font_rid: RID, size: int) virtual const 🔗

可选。

返回字偶距覆盖的列表。

bool _font_get_language_support_override(font_rid: RID, language: String) virtual 🔗

可选。

如果为 language 启用了支持覆盖，则返回 true。

PackedStringArray _font_get_language_support_overrides(font_rid: RID) virtual 🔗

可选。

返回语言支持覆盖的列表。

int _font_get_msdf_pixel_range(font_rid: RID) virtual const 🔗

可选。

返回最小和最大可表示有符号距离之间形状周围范围的宽度。

int _font_get_msdf_size(font_rid: RID) virtual const 🔗

可选。

返回用于生成 MSDF 纹理的源字体大小。

String _font_get_name(font_rid: RID) virtual const 🔗

可选。

返回字体家族名称。

Dictionary _font_get_opentype_feature_overrides(font_rid: RID) virtual const 🔗

可选。

返回字体 OpenType 特性集覆盖。

Dictionary _font_get_ot_name_strings(font_rid: RID) virtual const 🔗

可选。

返回 OpenType 字体名称字符串的 Dictionary（本地化的字体名称、版本、描述、许可信息、示例文本等）。

float _font_get_oversampling(font_rid: RID) virtual const 🔗

可选。

返回字体过采样系数，如果设置为 0.0，则使用全局过采样系数。仅由动态字体使用。

float _font_get_scale(font_rid: RID, size: int) virtual const 🔗

必选。

返回颜色位图字体的缩放系数。

bool _font_get_script_support_override(font_rid: RID, script: String) virtual 🔗

可选。

如果为 script 启用了支持覆盖，则返回 true。

PackedStringArray _font_get_script_support_overrides(font_rid: RID) virtual 🔗

可选。

返回文字支持覆盖的列表。

Array[Vector2i] _font_get_size_cache_list(font_rid: RID) virtual const 🔗

必选。

返回缓存中字体大小的列表。每个大小都是由字体大小和轮廓大小组成的 Vector2i。

int _font_get_spacing(font_rid: RID, spacing: SpacingType) virtual const 🔗

可选。

返回 spacing（见 SpacingType）的间距，单位为像素（与字体大小无关）。

int _font_get_stretch(font_rid: RID) virtual const 🔗

可选。

返回与正常宽度相比的字体拉伸量。一个介于 50% 和 200% 之间的百分比值。

BitField[FontStyle] _font_get_style(font_rid: RID) virtual const 🔗

可选。

返回字体样式标志，见 FontStyle。

String _font_get_style_name(font_rid: RID) virtual const 🔗

可选。

返回字体样式名称。

SubpixelPositioning _font_get_subpixel_positioning(font_rid: RID) virtual const 🔗

可选。

返回字体的次像素字形定位模式。

String _font_get_supported_chars(font_rid: RID) virtual const 🔗

必选。

返回包含字体中所有可用字符的字符串。

int _font_get_texture_count(font_rid: RID, size: Vector2i) virtual const 🔗

必选。

返回字体缓存条目所使用的纹理数。

Image _font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) virtual const 🔗

必选。

返回字体缓存纹理图像数据。

PackedInt32Array _font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) virtual const 🔗

可选。

返回包含字形打包数据的数组。

Transform2D _font_get_transform(font_rid: RID) virtual const 🔗

可选。

返回应用于字体轮廓的 2D 变换。

float _font_get_underline_position(font_rid: RID, size: int) virtual const 🔗

必选。

返回基线下方下划线的像素偏移。

float _font_get_underline_thickness(font_rid: RID, size: int) virtual const 🔗

必选。

返回下划线的粗细度，单位为像素。

Dictionary _font_get_variation_coordinates(font_rid: RID) virtual const 🔗

可选。

返回指定字体缓存条目的变体坐标。

int _font_get_weight(font_rid: RID) virtual const 🔗

可选。

返回该字体的字重（粗度）。一个在 100...999 范围内的值，正常字体字重为 400，粗体字体字重为 700。

bool _font_has_char(font_rid: RID, char: int) virtual const 🔗

必选。

如果该字体中包含 Unicode 字符 char，则返回 true。

bool _font_is_allow_system_fallback(font_rid: RID) virtual const 🔗

可选。

如果可以自动使用系统字体作为回退字体，则返回 true。

bool _font_is_force_autohinter(font_rid: RID) virtual const 🔗

可选。

如果设置为 true，则支持自动微调，优先于字体内置微调。

bool _font_is_language_supported(font_rid: RID, language: String) virtual const 🔗

可选。

如果该字体支持给定的语言（ISO 639 代码），则返回 true。

bool _font_is_multichannel_signed_distance_field(font_rid: RID) virtual const 🔗

可选。

如果使用从动态字体矢量数据生成的单个多通道有符号距离场渲染所有大小的字形，则返回 true。

bool _font_is_script_supported(font_rid: RID, script: String) virtual const 🔗

可选。

如果字体支持给定的文字（ISO 15924 代码），则返回 true。

void _font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) virtual 🔗

必选。

从缓存条目中移除指定的字体大小。

void _font_remove_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual 🔗

可选。

移除字形对的字偶距覆盖。

void _font_remove_language_support_override(font_rid: RID, language: String) virtual 🔗

可选。

移除语言支持覆盖。

void _font_remove_script_support_override(font_rid: RID, script: String) virtual 🔗

可选。

移除文字支持覆盖。

void _font_remove_size_cache(font_rid: RID, size: Vector2i) virtual 🔗

必选。

从缓存条目中移除指定的字体大小。

void _font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) virtual 🔗

必选。

从缓存条目中移除指定的字体大小。

void _font_render_glyph(font_rid: RID, size: Vector2i, index: int) virtual 🔗

可选。

将指定的字符渲染到字体缓存纹理。

void _font_render_range(font_rid: RID, size: Vector2i, start: int, end: int) virtual 🔗

可选。

将范围内的字符渲染到字体缓存纹理。

void _font_set_allow_system_fallback(font_rid: RID, allow_system_fallback: bool) virtual 🔗

可选。

如果设置为 true，则可以自动将系统字体作为回退使用。

void _font_set_antialiasing(font_rid: RID, antialiasing: FontAntialiasing) virtual 🔗

可选。

设置字体的抗锯齿模式。

void _font_set_ascent(font_rid: RID, size: int, ascent: float) virtual 🔗

必选。

设置字体的升部（基线上方的像素数）。

void _font_set_baseline_offset(font_rid: RID, baseline_offset: float) virtual 🔗

可选。

设置额外的基线偏移（作为字体高度的一部分）。

void _font_set_data(font_rid: RID, data: PackedByteArray) virtual 🔗

可选。

设置字体源数据，例如动态字体的源文件内容。

void _font_set_data_ptr(font_rid: RID, data_ptr: const uint8_t*, data_size: int) virtual 🔗

可选。

设置字体源数据指针，例如动态字体的源文件内容。

void _font_set_descent(font_rid: RID, size: int, descent: float) virtual 🔗

必选。

设置字体的降部（基线下方的像素数）。

void _font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) virtual 🔗

可选。

如果设置为 true，则禁用内嵌字体位图的加载。

void _font_set_embolden(font_rid: RID, strength: float) virtual 🔗

设置字体的加粗强度。如果 strength 不等于零，则会加粗字体轮廓。负值会减小轮廓的粗细度。

void _font_set_face_index(font_rid: RID, face_index: int) virtual 🔗

可选。

在 TrueType / OpenType 集合中设置活动字体索引。

void _font_set_fixed_size(font_rid: RID, fixed_size: int) virtual 🔗

必选。

设置位图字体的固定大小。如果设置为大于零的值，则会为所有字体大小使用相同的缓存条目。

void _font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) virtual 🔗

必选。

设置位图字体缩放模式。仅当 fixed_size 大于零时才使用该属性。

void _font_set_force_autohinter(font_rid: RID, force_autohinter: bool) virtual 🔗

可选。

如果设置为 true，则优先使用自动微调，而不是字体的内置微调。

void _font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool) virtual 🔗

可选。

如果设置为 true，则启用字体纹理 mipmap 生成。

void _font_set_global_oversampling(oversampling: float) virtual 🔗

可选。

设置字体过采样系数，由 TextServer 中的所有字体共享。

void _font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) virtual 🔗

必选。

设置字形推进（下一个字形的偏移量）。

void _font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) virtual 🔗

必选。

设置字形相对于基线的偏移量。

void _font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) virtual 🔗

必选。

设置字形的大小。

void _font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) virtual 🔗

必选。

设置包含该字形的缓存纹理的索引。

void _font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) virtual 🔗

必选。

设置包含该字形的缓存纹理中，该字形的矩形区域。

void _font_set_hinting(font_rid: RID, hinting: Hinting) virtual 🔗

可选。

设置字体微调模式。仅由动态字体使用。

void _font_set_kerning(font_rid: RID, size: int, glyph_pair: Vector2i, kerning: Vector2) virtual 🔗

可选。

设置字形对的字偶距。

void _font_set_language_support_override(font_rid: RID, language: String, supported: bool) virtual 🔗

可选。

为 _font_is_language_supported 添加覆盖。

void _font_set_msdf_pixel_range(font_rid: RID, msdf_pixel_range: int) virtual 🔗

可选。

设置最小和最大可表示有符号距离之间形状周围范围的宽度。

void _font_set_msdf_size(font_rid: RID, msdf_size: int) virtual 🔗

可选。

设置用于生成 MSDF 纹理的源字体大小。

void _font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool) virtual 🔗

可选。

如果设置为 true，则所有大小的字形都使用从动态字体向量数据生成的单个多通道带符号距离场进行渲染。MSDF 渲染能够使用任意缩放系数显示字体，字体不会变得模糊，字体大小的改变也不会消耗 CPU 的性能（因为字体不再需要在 CPU 上进行光栅化）。缺点是MSDF 无法使用字体微调。缺少字体微调时，锐度可能降低，较小的字体可能不易阅读。

void _font_set_name(font_rid: RID, name: String) virtual 🔗

可选。

设置该字体的家族名称。

void _font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary) virtual 🔗

可选。

设置字体 OpenType 特性集覆盖。

void _font_set_oversampling(font_rid: RID, oversampling: float) virtual 🔗

可选。

设置字体的过采样系数，如果设置为 0.0，则会改用全局过采样系数。仅由动态字体使用。

void _font_set_scale(font_rid: RID, size: int, scale: float) virtual 🔗

必选。

设置彩色位图字体的缩放系数。

void _font_set_script_support_override(font_rid: RID, script: String, supported: bool) virtual 🔗

可选。

为 _font_is_script_supported 添加覆盖。

void _font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) virtual 🔗

可选。

将 spacing 的间距（见 SpacingType）设置为 value，单位为像素（与字体大小无关）。

void _font_set_stretch(font_rid: RID, stretch: int) virtual 🔗

可选。

返回与正常宽度相比的字体拉伸量。一个介于 50% 和 200% 之间的百分比值。

void _font_set_style(font_rid: RID, style: BitField[FontStyle]) virtual 🔗

可选。

返回字体样式标志，见 FontStyle。

void _font_set_style_name(font_rid: RID, name_style: String) virtual 🔗

可选。

设置字体的样式名称。

void _font_set_subpixel_positioning(font_rid: RID, subpixel_positioning: SubpixelPositioning) virtual 🔗

可选。

设置字体的次像素字形定位模式。

void _font_set_texture_image(font_rid: RID, size: Vector2i, texture_index: int, image: Image) virtual 🔗

必选。

设置字体的缓存纹理图像数据。

void _font_set_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int, offset: PackedInt32Array) virtual 🔗

可选。

设置包含字形打包数据的数组。

void _font_set_transform(font_rid: RID, transform: Transform2D) virtual 🔗

可选。

设置应用于字体轮廓的 2D 变换，可用于倾斜、翻转和旋转字形。

void _font_set_underline_position(font_rid: RID, size: int, underline_position: float) virtual 🔗

必选。

设置基线下方下划线的像素偏移。

void _font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) virtual 🔗

必选。

设置下划线的粗细度，单位为像素。

void _font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) virtual 🔗

可选。

为指定的字体缓存条目设置变体坐标。

void _font_set_weight(font_rid: RID, weight: int) virtual 🔗

可选。

设置该字体的字重（粗度）。一个在 100...999 范围内的值，正常字体字重为 400，粗体字体字重为 700。

Dictionary _font_supported_feature_list(font_rid: RID) virtual const 🔗

可选。

返回支持的 OpenType 特性的字典。

Dictionary _font_supported_variation_list(font_rid: RID) virtual const 🔗

可选。

返回支持的 OpenType 变体坐标的字典。

String _format_number(number: String, language: String) virtual const 🔗

可选。

将数字从阿拉伯数字（0..9）转换为 language 语言的记数系统。

void _free_rid(rid: RID) virtual 🔗

必选。

释放由该 TextServer 创建的某个对象。

int _get_features() virtual const 🔗

必选。

返回文本服务器的功能，见 Feature。

Vector2 _get_hex_code_box_size(size: int, index: int) virtual const 🔗

可选。

返回替换字符的大小（在无效字符处绘制的带十六进制字符代码的框）。

String _get_name() virtual const 🔗

必选。

返回该服务器接口的名称。

String _get_support_data_filename() virtual const 🔗

可选。

返回默认的 TextServer 数据库（例如 ICU 中断迭代器和字典）文件名。

String _get_support_data_info() virtual const 🔗

可选。

返回 TextServer 数据库（例如 ICU 中断迭代器和字典）的描述。

bool _has(rid: RID) virtual 🔗

必选。

如果 rid 是该文本服务器拥有的有效资源，则返回 true。

bool _has_feature(feature: Feature) virtual const 🔗

必选。

如果服务器支持某个功能，则返回 true。

int _is_confusable(string: String, dict: PackedStringArray) virtual const 🔗

可选。

返回 dict 中第一个与 string 在视觉上可能产生混淆的字符串的索引，如果没有找到则返回 -1。

bool _is_locale_right_to_left(locale: String) virtual const 🔗

必选。

如果区域设置为从右至左，则返回 true。

bool _is_valid_identifier(string: String) virtual const 🔗

可选。

如果 string 是有效的标识符，则返回 true。

bool _is_valid_letter(unicode: int) virtual const 🔗

该方法目前没有描述，请帮我们贡献一个吧！

bool _load_support_data(filename: String) virtual 🔗

可选。

加载可选的 TextServer 数据库（例如 ICU 中断迭代器和字典）。

int _name_to_tag(name: String) virtual const 🔗

可选。

将可读的特性、变体、文字、语言名称转换为 OpenType 标记。

String _parse_number(number: String, language: String) virtual const 🔗

可选。

将数字 number 从 language 的记数系统转换为阿拉伯数字（0..9）。

Array[Vector3i] _parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) virtual const 🔗

可选。

BiDi 算法覆盖函数的默认实现。有关详细信息，请参阅 StructuredTextParser。

String _percent_sign(language: String) virtual const 🔗

可选。

返回语言 language 中使用的百分比符号。

bool _save_support_data(filename: String) virtual const 🔗

可选。

将可选的 TextServer 数据库（例如 ICU 中断迭代器和字典）保存至文件。

int _shaped_get_span_count(shaped: RID) virtual const 🔗

必需。

返回使用 _shaped_text_add_string 或 _shaped_text_add_object 添加的文本跨度数。

Variant _shaped_get_span_meta(shaped: RID, index: int) virtual const 🔗

必选。

返回文本区间的元数据。

void _shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary) virtual 🔗

必选。

在不更改文本的情况下，更改文本区间的字体、字体大小和 OpenType 功能。

bool _shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, length: int, baseline: float) virtual 🔗

必需。

将内联对象添加到文本缓冲区，key 必须是唯一的。在文本中，对象表示为 length 个对象替换字符。

bool _shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary, language: String, meta: Variant) virtual 🔗

必选。

添加文本区间和字体，将其绘制到文本缓冲中。

void _shaped_text_clear(shaped: RID) virtual 🔗

必选。

清空文本缓冲（移除文本和内联对象）。

int _shaped_text_closest_character_pos(shaped: RID, pos: int) virtual const 🔗

可选。

返回距离 pos 最近的组合字符位置。

void _shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, color: Color) virtual const 🔗

可选。

在画布项的给定位置绘制塑形后的文本，颜色为 color。pos 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。

void _shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, outline_size: int, color: Color) virtual const 🔗

可选。

在画布项的给定位置绘制塑形后的文本轮廓，颜色为 color。pos 指定的是基线的最左侧（横向排版）或基线的最顶部（纵向排版）。

float _shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag]) virtual 🔗

可选。

两端对齐文本以适合指定宽度，返回新的文本宽度。

float _shaped_text_get_ascent(shaped: RID) virtual const 🔗

必选。

返回该文本的升部（水平排版时为基线上方的像素数，垂直排版时为基线左侧的像素数）。

void _shaped_text_get_carets(shaped: RID, position: int, caret: CaretInfo*) virtual const 🔗

可选。

返回与文本中字符偏移 position 对应的文本光标的形状。返回的光标形状是宽度为 1 像素的矩形。

PackedInt32Array _shaped_text_get_character_breaks(shaped: RID) virtual const 🔗

可选。

返回组合字符边界的数组。

int _shaped_text_get_custom_ellipsis(shaped: RID) virtual const 🔗

可选。

返回文字裁剪时使用的省略字符。

String _shaped_text_get_custom_punctuation(shaped: RID) virtual const 🔗

可选。

返回自定义标点字符列表，用于断字。如果被设置为空字符串，则使用服务器的默认值。

float _shaped_text_get_descent(shaped: RID) virtual const 🔗

必选。

返回该文本的降部（水平排版时为基线下方的像素数，垂直排版时为基线右侧的像素数）。

Direction _shaped_text_get_direction(shaped: RID) virtual const 🔗

可选。

返回文本的方向。

int _shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) virtual const 🔗

可选。

返回文本范围内的主要书写方向。

int _shaped_text_get_ellipsis_glyph_count(shaped: RID) virtual const 🔗

必选。

返回省略号中的字形数。

const Glyph* _shaped_text_get_ellipsis_glyphs(shaped: RID) virtual const 🔗

必选。

返回省略号中的字形数组。

int _shaped_text_get_ellipsis_pos(shaped: RID) virtual const 🔗

必选。

返回省略号的位置。

int _shaped_text_get_glyph_count(shaped: RID) virtual const 🔗

必选。

返回缓冲区中的字形数。

const Glyph* _shaped_text_get_glyphs(shaped: RID) virtual const 🔗

必选。

返回字形数组，按视觉顺序排序。

Vector2 _shaped_text_get_grapheme_bounds(shaped: RID, pos: int) virtual const 🔗

可选。

将复合字符的边界返回为距行首的偏移量。

Direction _shaped_text_get_inferred_direction(shaped: RID) virtual const 🔗

可选。

返回由 BiDi 算法推断的文本书写方向。

PackedInt32Array _shaped_text_get_line_breaks(shaped: RID, width: float, start: int, break_flags: BitField[LineBreakFlag]) virtual const 🔗

可选。

对文本进行断行，返回每一行的字符范围。

PackedInt32Array _shaped_text_get_line_breaks_adv(shaped: RID, width: PackedFloat32Array, start: int, once: bool, break_flags: BitField[LineBreakFlag]) virtual const 🔗

可选。

将文本拆分为行和列。返回每段的字符范围。

int _shaped_text_get_object_glyph(shaped: RID, key: Variant) virtual const 🔗

必选。

返回内联对象的字形索引。

Vector2i _shaped_text_get_object_range(shaped: RID, key: Variant) virtual const 🔗

必选。

返回内联对象的字符范围。

Rect2 _shaped_text_get_object_rect(shaped: RID, key: Variant) virtual const 🔗

必选。

返回内联对象的边界矩形。

Array _shaped_text_get_objects(shaped: RID) virtual const 🔗

必选。

返回内联对象的数组。

Orientation _shaped_text_get_orientation(shaped: RID) virtual const 🔗

可选。

返回文本朝向。

RID _shaped_text_get_parent(shaped: RID) virtual const 🔗

必选。

返回子字符串源自哪个父缓冲区。

bool _shaped_text_get_preserve_control(shaped: RID) virtual const 🔗

可选。

如果文本缓冲区被配置为显示控制字符，则返回 true。

bool _shaped_text_get_preserve_invalid(shaped: RID) virtual const 🔗

可选。

如果文本缓冲区被配置为显示十六进制代码来代替无效字符，则返回 true。

Vector2i _shaped_text_get_range(shaped: RID) virtual const 🔗

必需。

返回父缓冲区中子字符串缓冲区的字符范围。

PackedVector2Array _shaped_text_get_selection(shaped: RID, start: int, end: int) virtual const 🔗

可选。

返回用于指定字符范围的选区矩形。

Vector2 _shaped_text_get_size(shaped: RID) virtual const 🔗

必选。

返回该文本的大小。

int _shaped_text_get_spacing(shaped: RID, spacing: SpacingType) virtual const 🔗

可选。

返回字形或行之间添加的额外间距，单位为像素。

int _shaped_text_get_trim_pos(shaped: RID) virtual const 🔗

必选。

返回超出修剪的位置。

float _shaped_text_get_underline_position(shaped: RID) virtual const 🔗

必选。

返回基线下方下划线的像素偏移。

float _shaped_text_get_underline_thickness(shaped: RID) virtual const 🔗

必选。

返回下划线的粗细度。

float _shaped_text_get_width(shaped: RID) virtual const 🔗

必选。

返回文本的宽度（对于水平排版）或高度（对于垂直排版）。

PackedInt32Array _shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag], skip_grapheme_flags: BitField[GraphemeFlag]) virtual const 🔗

可选。

将文本分解成单词并返回字符范围的数组。请使用 grapheme_flags 来设置哪些字符会被用于分解（见 GraphemeFlag）。

int _shaped_text_hit_test_grapheme(shaped: RID, coord: float) virtual const 🔗

可选。

返回字素的索引，该字素位于基线上指定像素偏移的位置，如果没有找到，则返回 -1。

int _shaped_text_hit_test_position(shaped: RID, coord: float) virtual const 🔗

可选。

返回基线处指定像素偏移处的文本光标的偏移量。该函数始终返回一个有效位置。

bool _shaped_text_is_ready(shaped: RID) virtual const 🔗

必选。

如果缓冲区成功塑形，则返回 true。

int _shaped_text_next_character_pos(shaped: RID, pos: int) virtual const 🔗

可选。

返回距离 pos 最近的组合字符结束位置。

int _shaped_text_next_grapheme_pos(shaped: RID, pos: int) virtual const 🔗

可选。

返回距离 pos 最近的字素结束位置。

void _shaped_text_overrun_trim_to_width(shaped: RID, width: float, trim_flags: BitField[TextOverrunFlag]) virtual 🔗

可选。

如果文本超出给定宽度，则修剪文本。

int _shaped_text_prev_character_pos(shaped: RID, pos: int) virtual const 🔗

可选。

返回距离 pos 最近的组合字符开始位置。

int _shaped_text_prev_grapheme_pos(shaped: RID, pos: int) virtual const 🔗

可选。

返回距离 pos 最近的字素开始位置。

bool _shaped_text_resize_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, baseline: float) virtual 🔗

可选。

设置嵌入对象的新大小和对齐方式。

void _shaped_text_set_bidi_override(shaped: RID, override: Array) virtual 🔗

可选。

为结构化文本设置 BiDi 算法覆盖。

void _shaped_text_set_custom_ellipsis(shaped: RID, char: int) virtual 🔗

可选。

设置文字裁剪时使用的省略字符。

void _shaped_text_set_custom_punctuation(shaped: RID, punct: String) virtual 🔗

可选。

设置自定义标点字符列表，用于断字。如果被设置为空字符串，则使用服务器的默认值。

void _shaped_text_set_direction(shaped: RID, direction: Direction) virtual 🔗

可选。

设置所需的文本方向。如果设置为 TextServer.DIRECTION_AUTO，方向将根据缓冲区的内容和当前的区域设置来检测。

void _shaped_text_set_orientation(shaped: RID, orientation: Orientation) virtual 🔗

可选。

设置想要的文本朝向。

void _shaped_text_set_preserve_control(shaped: RID, enabled: bool) virtual 🔗

可选。

如果设置为 true，则文本缓冲区将显示控制字符。

void _shaped_text_set_preserve_invalid(shaped: RID, enabled: bool) virtual 🔗

可选。

如果设置为 true，则文本缓冲区会将无效字符显示为十六进制代码，否则不显示任何内容。

void _shaped_text_set_spacing(shaped: RID, spacing: SpacingType, value: int) virtual 🔗

可选。

设置字形之间或行与行之间添加的额外像素间距。

bool _shaped_text_shape(shaped: RID) virtual 🔗

必选。

形状缓冲区（如果未塑形）。如果字符串塑形成功，则返回 true。

const Glyph* _shaped_text_sort_logical(shaped: RID) virtual 🔗

必选。

按逻辑顺序返回文本字形。

RID _shaped_text_substr(shaped: RID, start: int, length: int) virtual const 🔗

必选。

返回 shaped 文本缓冲区中字符串的子字符串的文本缓冲区（包括内联对象）。

float _shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) virtual 🔗

可选。

将塑形文本与给定的制表位对齐。

bool _shaped_text_update_breaks(shaped: RID) virtual 🔗

可选。

更新塑形文本中的断点。该方法由分词函数的默认实现调用。

bool _shaped_text_update_justification_ops(shaped: RID) virtual 🔗

可选。

更新塑形文本中的对齐点。该方法由文本对齐函数的默认实现调用。

bool _spoof_check(string: String) virtual const 🔗

可选。

如果 string 可能试图混淆读者，则返回 true。

PackedInt32Array _string_get_character_breaks(string: String, language: String) virtual const 🔗

可选。

返回组合字符边界的数组。

PackedInt32Array _string_get_word_breaks(string: String, language: String, chars_per_line: int) virtual const 🔗

可选。

返回分词边界的数组。数组中的元素是单词起始位置和结束位置的偏移量。因此数组的长度始终为偶数。

String _string_to_lower(string: String, language: String) virtual const 🔗

可选。

返回将该字符串转换为小写的结果。

String _string_to_title(string: String, language: String) virtual const 🔗

可选。

返回将该字符串转换为词首字母大写的结果。

String _string_to_upper(string: String, language: String) virtual const 🔗

可选。

返回将该字符串转换为大写的结果。

String _strip_diacritics(string: String) virtual const 🔗

可选。

从字符串中剥离变音符号。

String _tag_to_name(tag: int) virtual const 🔗

可选。

将 OpenType 标签转换为可读的特性、变体、文字或语言的名称。