Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
TextServerExtension
繼承: TextServer < RefCounted < Object
被繼承: TextServerAdvanced, TextServerDummy, TextServerFallback
自訂 TextServer 實作(外掛程式)的基底類別。
說明
外部的 TextServer 實作應該繼承這個類。
方法
void |
_cleanup() virtual |
_create_font() virtual required |
|
_create_font_linked_variation(font_rid: RID) virtual |
|
_create_shaped_text(direction: Direction, orientation: Orientation) virtual required |
|
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 required |
void |
_font_clear_kerning_map(font_rid: RID, size: int) virtual |
void |
_font_clear_size_cache(font_rid: RID) virtual required |
void |
_font_clear_system_fallback_cache() virtual |
void |
_font_clear_textures(font_rid: RID, size: Vector2i) virtual required |
void |
_font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const |
void |
_font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const |
_font_get_antialiasing(font_rid: RID) virtual const |
|
_font_get_ascent(font_rid: RID, size: int) virtual required const |
|
_font_get_baseline_offset(font_rid: RID) virtual const |
|
_font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) virtual required const |
|
_font_get_descent(font_rid: RID, size: int) virtual required const |
|
_font_get_disable_embedded_bitmaps(font_rid: RID) virtual const |
|
_font_get_embolden(font_rid: RID) virtual const |
|
_font_get_face_count(font_rid: RID) virtual const |
|
_font_get_face_index(font_rid: RID) virtual const |
|
_font_get_fixed_size(font_rid: RID) virtual required const |
|
_font_get_fixed_size_scale_mode(font_rid: RID) virtual required const |
|
_font_get_generate_mipmaps(font_rid: RID) virtual const |
|
_font_get_global_oversampling() virtual const |
|
_font_get_glyph_advance(font_rid: RID, size: int, glyph: int) virtual required const |
|
_font_get_glyph_contours(font_rid: RID, size: int, index: int) virtual const |
|
_font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) virtual required const |
|
_font_get_glyph_list(font_rid: RID, size: Vector2i) virtual required const |
|
_font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_hinting(font_rid: RID) virtual const |
|
_font_get_keep_rounding_remainders(font_rid: RID) virtual const |
|
_font_get_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual const |
|
_font_get_kerning_list(font_rid: RID, size: int) virtual const |
|
_font_get_language_support_override(font_rid: RID, language: String) virtual |
|
_font_get_language_support_overrides(font_rid: RID) virtual |
|
_font_get_msdf_pixel_range(font_rid: RID) virtual const |
|
_font_get_msdf_size(font_rid: RID) virtual const |
|
_font_get_name(font_rid: RID) virtual const |
|
_font_get_opentype_feature_overrides(font_rid: RID) virtual const |
|
_font_get_ot_name_strings(font_rid: RID) virtual const |
|
_font_get_oversampling(font_rid: RID) virtual const |
|
_font_get_palette_colors(font_rid: RID, index: int) virtual const |
|
_font_get_palette_count(font_rid: RID) virtual const |
|
_font_get_palette_custom_colors(font_rid: RID) virtual const |
|
_font_get_palette_name(font_rid: RID, index: int) virtual const |
|
_font_get_scale(font_rid: RID, size: int) virtual required const |
|
_font_get_script_support_override(font_rid: RID, script: String) virtual |
|
_font_get_script_support_overrides(font_rid: RID) virtual |
|
_font_get_size_cache_info(font_rid: RID) virtual const |
|
_font_get_size_cache_list(font_rid: RID) virtual required const |
|
_font_get_spacing(font_rid: RID, spacing: SpacingType) virtual const |
|
_font_get_stretch(font_rid: RID) virtual const |
|
BitField[FontStyle] |
_font_get_style(font_rid: RID) virtual const |
_font_get_style_name(font_rid: RID) virtual const |
|
_font_get_subpixel_positioning(font_rid: RID) virtual const |
|
_font_get_supported_chars(font_rid: RID) virtual required const |
|
_font_get_supported_glyphs(font_rid: RID) virtual required const |
|
_font_get_texture_count(font_rid: RID, size: Vector2i) virtual required const |
|
_font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) virtual required const |
|
_font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) virtual const |
|
_font_get_transform(font_rid: RID) virtual const |
|
_font_get_underline_position(font_rid: RID, size: int) virtual required const |
|
_font_get_underline_thickness(font_rid: RID, size: int) virtual required const |
|
_font_get_used_palette(font_rid: RID) virtual const |
|
_font_get_variation_coordinates(font_rid: RID) virtual const |
|
_font_get_weight(font_rid: RID) virtual const |
|
_font_has_char(font_rid: RID, char: int) virtual required const |
|
_font_is_allow_system_fallback(font_rid: RID) virtual const |
|
_font_is_force_autohinter(font_rid: RID) virtual const |
|
_font_is_language_supported(font_rid: RID, language: String) virtual const |
|
_font_is_modulate_color_glyphs(font_rid: RID) virtual const |
|
_font_is_multichannel_signed_distance_field(font_rid: RID) virtual const |
|
_font_is_script_supported(font_rid: RID, script: String) virtual const |
|
void |
_font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) virtual required |
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 required |
void |
_font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) virtual required |
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 |
void |
_font_set_antialiasing(font_rid: RID, antialiasing: FontAntialiasing) virtual |
void |
_font_set_ascent(font_rid: RID, size: int, ascent: float) virtual required |
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: |
void |
_font_set_descent(font_rid: RID, size: int, descent: float) virtual required |
void |
_font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) virtual |
void |
_font_set_embolden(font_rid: RID, strength: float) virtual |
void |
_font_set_face_index(font_rid: RID, face_index: int) virtual |
void |
_font_set_fixed_size(font_rid: RID, fixed_size: int) virtual required |
void |
_font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) virtual required |
void |
_font_set_force_autohinter(font_rid: RID, force_autohinter: bool) virtual |
void |
_font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool) virtual |
void |
_font_set_global_oversampling(oversampling: float) virtual |
void |
_font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) virtual required |
void |
_font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) virtual required |
void |
_font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) virtual required |
void |
_font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) virtual required |
void |
_font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) virtual required |
void |
_font_set_hinting(font_rid: RID, hinting: Hinting) virtual |
void |
_font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool) 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 |
void |
_font_set_modulate_color_glyphs(font_rid: RID, modulate: bool) virtual |
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 |
void |
_font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool) virtual |
void |
_font_set_name(font_rid: RID, name: String) virtual |
void |
_font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary) virtual |
void |
_font_set_oversampling(font_rid: RID, oversampling: float) virtual |
void |
_font_set_palette_custom_colors(font_rid: RID, colors: PackedColorArray) virtual |
void |
_font_set_scale(font_rid: RID, size: int, scale: float) virtual required |
void |
_font_set_script_support_override(font_rid: RID, script: String, supported: bool) virtual |
void |
_font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) virtual |
void |
_font_set_stretch(font_rid: RID, stretch: int) virtual |
void |
_font_set_style(font_rid: RID, style: BitField[FontStyle]) virtual |
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 required |
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 |
void |
_font_set_underline_position(font_rid: RID, size: int, underline_position: float) virtual required |
void |
_font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) virtual required |
void |
_font_set_used_palette(font_rid: RID, index: int) virtual |
void |
_font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) virtual |
void |
_font_set_weight(font_rid: RID, weight: int) virtual |
_font_supported_feature_list(font_rid: RID) virtual const |
|
_font_supported_variation_list(font_rid: RID) virtual const |
|
_format_number(number: String, language: String) virtual const |
|
void |
|
_get_features() virtual required const |
|
_get_hex_code_box_size(size: int, index: int) virtual const |
|
_get_name() virtual required const |
|
_get_support_data() virtual const |
|
_get_support_data_filename() virtual const |
|
_get_support_data_info() virtual const |
|
_has_feature(feature: Feature) virtual required const |
|
_is_confusable(string: String, dict: PackedStringArray) virtual const |
|
_is_locale_right_to_left(locale: String) virtual const |
|
_is_locale_using_support_data(locale: String) virtual const |
|
_is_valid_identifier(string: String) virtual const |
|
_is_valid_letter(unicode: int) virtual const |
|
_load_support_data(filename: String) virtual |
|
_name_to_tag(name: String) virtual const |
|
_parse_number(number: String, language: String) virtual const |
|
_parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) virtual const |
|
_percent_sign(language: String) virtual const |
|
void |
_reference_oversampling_level(oversampling: float) virtual |
_save_support_data(filename: String) virtual const |
|
_shaped_get_run_count(shaped: RID) virtual const |
|
_shaped_get_run_direction(shaped: RID, index: int) virtual const |
|
_shaped_get_run_font_rid(shaped: RID, index: int) virtual const |
|
_shaped_get_run_font_size(shaped: RID, index: int) virtual const |
|
_shaped_get_run_glyph_range(shaped: RID, index: int) virtual const |
|
_shaped_get_run_language(shaped: RID, index: int) virtual const |
|
_shaped_get_run_object(shaped: RID, index: int) virtual const |
|
_shaped_get_run_range(shaped: RID, index: int) virtual const |
|
_shaped_get_run_text(shaped: RID, index: int) virtual const |
|
_shaped_get_span_count(shaped: RID) virtual required const |
|
_shaped_get_span_embedded_object(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_meta(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_object(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_text(shaped: RID, index: int) virtual required const |
|
_shaped_get_text(shaped: RID) virtual required const |
|
void |
_shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary) virtual required |
_shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, length: int, baseline: float) virtual required |
|
_shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary, language: String, meta: Variant) virtual required |
|
void |
_shaped_text_clear(shaped: RID) virtual required |
_shaped_text_closest_character_pos(shaped: RID, pos: int) virtual const |
|
void |
_shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, color: Color, oversampling: float) virtual const |
void |
_shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, outline_size: int, color: Color, oversampling: float) virtual const |
_shaped_text_duplicate(shaped: RID) virtual required |
|
_shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag]) virtual |
|
_shaped_text_get_ascent(shaped: RID) virtual required const |
|
void |
_shaped_text_get_carets(shaped: RID, position: int, r_caret: |
_shaped_text_get_character_breaks(shaped: RID) virtual const |
|
_shaped_text_get_custom_ellipsis(shaped: RID) virtual const |
|
_shaped_text_get_custom_punctuation(shaped: RID) virtual const |
|
_shaped_text_get_descent(shaped: RID) virtual required const |
|
_shaped_text_get_direction(shaped: RID) virtual const |
|
_shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) virtual const |
|
_shaped_text_get_ellipsis_glyph_count(shaped: RID) virtual required const |
|
|
_shaped_text_get_ellipsis_glyphs(shaped: RID) virtual required const |
_shaped_text_get_ellipsis_pos(shaped: RID) virtual required const |
|
_shaped_text_get_glyph_count(shaped: RID) virtual required const |
|
|
_shaped_text_get_glyphs(shaped: RID) virtual required const |
_shaped_text_get_grapheme_bounds(shaped: RID, pos: int) virtual const |
|
_shaped_text_get_inferred_direction(shaped: RID) virtual const |
|
_shaped_text_get_line_breaks(shaped: RID, width: float, start: int, break_flags: BitField[LineBreakFlag]) virtual const |
|
_shaped_text_get_line_breaks_adv(shaped: RID, width: PackedFloat32Array, start: int, once: bool, break_flags: BitField[LineBreakFlag]) virtual const |
|
_shaped_text_get_object_glyph(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_object_range(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_object_rect(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_objects(shaped: RID) virtual required const |
|
_shaped_text_get_orientation(shaped: RID) virtual const |
|
_shaped_text_get_parent(shaped: RID) virtual required const |
|
_shaped_text_get_preserve_control(shaped: RID) virtual const |
|
_shaped_text_get_preserve_invalid(shaped: RID) virtual const |
|
_shaped_text_get_range(shaped: RID) virtual required const |
|
_shaped_text_get_selection(shaped: RID, start: int, end: int) virtual const |
|
_shaped_text_get_size(shaped: RID) virtual required const |
|
_shaped_text_get_spacing(shaped: RID, spacing: SpacingType) virtual const |
|
_shaped_text_get_trim_pos(shaped: RID) virtual required const |
|
_shaped_text_get_underline_position(shaped: RID) virtual required const |
|
_shaped_text_get_underline_thickness(shaped: RID) virtual required const |
|
_shaped_text_get_width(shaped: RID) virtual required const |
|
_shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag], skip_grapheme_flags: BitField[GraphemeFlag]) virtual const |
|
_shaped_text_has_object(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_hit_test_grapheme(shaped: RID, coord: float) virtual const |
|
_shaped_text_hit_test_position(shaped: RID, coord: float) virtual const |
|
_shaped_text_is_ready(shaped: RID) virtual required const |
|
_shaped_text_next_character_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_next_grapheme_pos(shaped: RID, pos: int) virtual const |
|
void |
_shaped_text_overrun_trim_to_width(shaped: RID, width: float, trim_flags: BitField[TextOverrunFlag]) virtual |
_shaped_text_prev_character_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_prev_grapheme_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_resize_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, baseline: float) virtual required |
|
void |
_shaped_text_set_bidi_override(shaped: RID, override: Array) virtual |
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 |
void |
_shaped_text_set_orientation(shaped: RID, orientation: Orientation) virtual |
void |
_shaped_text_set_preserve_control(shaped: RID, enabled: bool) virtual |
void |
_shaped_text_set_preserve_invalid(shaped: RID, enabled: bool) virtual |
void |
_shaped_text_set_spacing(shaped: RID, spacing: SpacingType, value: int) virtual |
_shaped_text_shape(shaped: RID) virtual required |
|
|
_shaped_text_sort_logical(shaped: RID) virtual required |
_shaped_text_substr(shaped: RID, start: int, length: int) virtual required const |
|
_shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) virtual |
|
_shaped_text_update_breaks(shaped: RID) virtual |
|
_shaped_text_update_justification_ops(shaped: RID) virtual |
|
_spoof_check(string: String) virtual const |
|
_string_get_character_breaks(string: String, language: String) virtual const |
|
_string_get_word_breaks(string: String, language: String, chars_per_line: int) virtual const |
|
_string_to_lower(string: String, language: String) virtual const |
|
_string_to_title(string: String, language: String) virtual const |
|
_string_to_upper(string: String, language: String) virtual const |
|
_strip_diacritics(string: String) virtual const |
|
_tag_to_name(tag: int) virtual const |
|
void |
_unreference_oversampling_level(oversampling: float) virtual |
方法說明
void _cleanup() virtual 🔗
This method is called before text server is unregistered.
RID _create_font() virtual required 🔗
Creates a new, empty font cache entry resource.
RID _create_font_linked_variation(font_rid: RID) virtual 🔗
Optional, implement if font supports extra spacing or baseline offset.
Creates a new variation existing font which is reusing the same glyph cache and font data.
RID _create_shaped_text(direction: Direction, orientation: Orientation) virtual required 🔗
Creates a new buffer for complex text layout, with the given direction and orientation.
void _draw_hex_code_box(canvas: RID, size: int, pos: Vector2, index: int, color: Color) virtual const 🔗
Draws box displaying character hexadecimal code.
void _font_clear_glyphs(font_rid: RID, size: Vector2i) virtual required 🔗
Removes all rendered glyph information from the cache entry.
void _font_clear_kerning_map(font_rid: RID, size: int) virtual 🔗
移除所有字距調整覆蓋。
void _font_clear_size_cache(font_rid: RID) virtual required 🔗
從快取條目中移除所有的字形大小。
void _font_clear_system_fallback_cache() virtual 🔗
Frees all automatically loaded system fonts.
void _font_clear_textures(font_rid: RID, size: Vector2i) virtual required 🔗
Removes all textures from font cache entry.
void _font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const 🔗
Draws single glyph into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
void _font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const 🔗
Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
FontAntialiasing _font_get_antialiasing(font_rid: RID) virtual const 🔗
返回字形的抗鋸齒模式。
float _font_get_ascent(font_rid: RID, size: int) virtual required const 🔗
返回字形的上升幅度(超出基線的圖元數)。
float _font_get_baseline_offset(font_rid: RID) virtual const 🔗
Returns extra baseline offset (as a fraction of font height).
int _font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) virtual required const 🔗
Returns character code associated with glyph_index, or 0 if glyph_index is invalid.
float _font_get_descent(font_rid: RID, size: int) virtual required const 🔗
返回字形的減少量(低於基線的圖元數)。
bool _font_get_disable_embedded_bitmaps(font_rid: RID) virtual const 🔗
Returns whether the font's embedded bitmap loading is disabled.
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 required const 🔗
返回點陣字型的固定大小。
FixedSizeScaleMode _font_get_fixed_size_scale_mode(font_rid: RID) virtual required const 🔗
Returns bitmap font scaling mode.
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 required const 🔗
Returns glyph advance (offset of the next glyph).
Dictionary _font_get_glyph_contours(font_rid: RID, size: int, index: int) virtual const 🔗
Returns outline contours of the glyph.
int _font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) virtual required const 🔗
返回 char 的字形索引,可以用 variation_selector 修改。
PackedInt32Array _font_get_glyph_list(font_rid: RID, size: Vector2i) virtual required const 🔗
返回快取條目中的已算繪字形列表。
Vector2 _font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回字形的基線偏移量。
Vector2 _font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回該字形的大小。
int _font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回包含該字形的快取紋理的索引。
RID _font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
Returns resource ID of the cache texture containing the glyph.
Vector2 _font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
Returns size of the cache texture containing the glyph.
Rect2 _font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回包含該字形的快取紋理中的矩形。
Hinting _font_get_hinting(font_rid: RID) virtual const 🔗
返回字形微調模式。僅用於動態字形。
bool _font_get_keep_rounding_remainders(font_rid: RID) virtual const 🔗
Returns glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
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 🔗
Returns oversampling factor override. If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.oversampling. This value doesn't override the oversampling parameter of draw_* methods. Used by dynamic fonts only.
PackedColorArray _font_get_palette_colors(font_rid: RID, index: int) virtual const 🔗
Returns the array in the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors. Colors can be overridden using _font_set_palette_custom_colors().
int _font_get_palette_count(font_rid: RID) virtual const 🔗
Returns the number of predefined color palettes. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.
PackedColorArray _font_get_palette_custom_colors(font_rid: RID) virtual const 🔗
Returns array of custom colors to override predefined palette.
String _font_get_palette_name(font_rid: RID, index: int) virtual const 🔗
Returns the name of the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.
float _font_get_scale(font_rid: RID, size: int) virtual required 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[Dictionary] _font_get_size_cache_info(font_rid: RID) virtual const 🔗
Returns font cache information, each entry contains the following fields: Vector2i size_px - font size in pixels, float viewport_oversampling - viewport oversampling factor, int glyphs - number of rendered glyphs, int textures - number of used textures, int textures_size - size of texture data in bytes.
Array[Vector2i] _font_get_size_cache_list(font_rid: RID) virtual required const 🔗
Returns list of the font sizes in the cache. Each size is Vector2i with font size and outline size.
int _font_get_spacing(font_rid: RID, spacing: SpacingType) virtual const 🔗
Returns the spacing for spacing in pixels (not relative to the font size).
int _font_get_stretch(font_rid: RID) virtual const 🔗
返回與正常寬度相比的字形拉伸量。一個介於 50% 和 200% 之間的百分比值。
BitField[FontStyle] _font_get_style(font_rid: RID) virtual const 🔗
Returns font style flags.
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 required const 🔗
返回包含字形中所有可用字元的字串。
PackedInt32Array _font_get_supported_glyphs(font_rid: RID) virtual required const 🔗
Returns an array containing all glyph indices in the font.
int _font_get_texture_count(font_rid: RID, size: Vector2i) virtual required const 🔗
返回字形快取條目所使用的紋理數。
Image _font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) virtual required 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 required const 🔗
返回基線下方底線的圖元偏移。
float _font_get_underline_thickness(font_rid: RID, size: int) virtual required const 🔗
返回底線的粗細度,單位為圖元。
int _font_get_used_palette(font_rid: RID) virtual const 🔗
Returns used palette index.
Dictionary _font_get_variation_coordinates(font_rid: RID) virtual const 🔗
Returns variation coordinates for the specified font cache entry.
int _font_get_weight(font_rid: RID) virtual const 🔗
返回該字形的字重(粗度)。一個在 100...999 範圍內的值,正常字形字重為 400,粗體字形字重為 700。
bool _font_has_char(font_rid: RID, char: int) virtual required 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 🔗
Returns true if auto-hinting is supported and preferred over font built-in hinting.
bool _font_is_language_supported(font_rid: RID, language: String) virtual const 🔗
Returns true if the font supports the given language (as a ISO 639 code).
bool _font_is_modulate_color_glyphs(font_rid: RID) virtual const 🔗
Returns true if color modulation is applied when drawing the font's colored glyphs.
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 🔗
Returns true if the font supports the given script (as a ISO 15924 code).
void _font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) virtual required 🔗
Removes specified rendered glyph information from the cache entry.
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 required 🔗
從快取條目中移除指定的字形大小。
void _font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) virtual required 🔗
Removes specified texture from the cache entry.
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 required 🔗
設定字形的升部(基線上方的圖元數)。
void _font_set_baseline_offset(font_rid: RID, baseline_offset: float) virtual 🔗
Sets extra baseline offset (as a fraction of font height).
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 🔗
Sets pointer to the font source data, e.g contents of the dynamic font source file.
void _font_set_descent(font_rid: RID, size: int, descent: float) virtual required 🔗
設定字形的降部(基線下方的圖元數)。
void _font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) virtual 🔗
If set to true, embedded font bitmap loading is disabled.
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 required 🔗
設定點陣字型的固定大小。如果設定為大於零的值,則會為所有字形大小使用相同的緩存條目。
void _font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) virtual required 🔗
Sets bitmap font scaling mode. This property is used only if fixed_size is greater than zero.
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 🔗
Sets oversampling factor, shared by all font in the TextServer.
void _font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) virtual required 🔗
Sets glyph advance (offset of the next glyph).
void _font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) virtual required 🔗
設定字形相對於基線的偏移量。
void _font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) virtual required 🔗
設定字形的大小。
void _font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) virtual required 🔗
設定包含該字形的快取紋理的索引。
void _font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) virtual required 🔗
設定包含該字形的快取紋理中,該字形的矩形區域。
void _font_set_hinting(font_rid: RID, hinting: Hinting) virtual 🔗
設定字形微調模式。僅由動態字形使用。
void _font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool) virtual 🔗
Sets glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
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 🔗
Adds override for _font_is_language_supported().
void _font_set_modulate_color_glyphs(font_rid: RID, modulate: bool) virtual 🔗
If set to true, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only.
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 🔗
If set to true, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.
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 🔗
If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.oversampling. This value doesn't override the oversampling parameter of draw_* methods. Used by dynamic fonts only.
void _font_set_palette_custom_colors(font_rid: RID, colors: PackedColorArray) virtual 🔗
Sets array of custom colors to override predefined palette. Set to empty array to reset overrides. Use Color(0, 0, 0, 0), to keep predefined palette color at specific position.
void _font_set_scale(font_rid: RID, size: int, scale: float) virtual required 🔗
設定彩色點陣字型的縮放係數。
void _font_set_script_support_override(font_rid: RID, script: String, supported: bool) virtual 🔗
Adds override for _font_is_script_supported().
void _font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) virtual 🔗
Sets the spacing for spacing to value in pixels (not relative to the font size).
void _font_set_stretch(font_rid: RID, stretch: int) virtual 🔗
Sets font stretch amount, compared to a normal width. A percentage value between 50% and 200%.
void _font_set_style(font_rid: RID, style: BitField[FontStyle]) virtual 🔗
Sets the font style flags.
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 required 🔗
設定字形的快取紋理圖像資料。
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 🔗
Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
void _font_set_underline_position(font_rid: RID, size: int, underline_position: float) virtual required 🔗
設定基線下方底線的圖元偏移。
void _font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) virtual required 🔗
設定底線的粗細度,單位為圖元。
void _font_set_used_palette(font_rid: RID, index: int) virtual 🔗
Sets used palette index.
void _font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) virtual 🔗
Sets variation coordinates for the specified font cache entry.
void _font_set_weight(font_rid: RID, weight: int) virtual 🔗
Sets weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 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 🔗
已棄用: Use TranslationServer.format_number() instead.
Converts a number from Western Arabic (0..9) to the numeral system used in the given language.
If language is an empty string, the active locale will be used.
void _free_rid(rid: RID) virtual required 🔗
釋放由該 TextServer 建立的某個對象。
int _get_features() virtual required const 🔗
Returns text server features, see Feature.
Vector2 _get_hex_code_box_size(size: int, index: int) virtual const 🔗
返回替換字元的大小(在無效字元處繪製的帶十六進位字元程式碼的框)。
String _get_name() virtual required const 🔗
返回該伺服器介面的名稱。
PackedByteArray _get_support_data() virtual const 🔗
Returns default TextServer database (e.g. ICU break iterators and dictionaries).
String _get_support_data_filename() virtual const 🔗
返回預設的 TextServer 資料庫(例如 ICU 中斷反覆運算器和字典)檔案名。
String _get_support_data_info() virtual const 🔗
返回 TextServer 資料庫(例如 ICU 中斷反覆運算器和字典)的描述。
bool _has(rid: RID) virtual required 🔗
如果 rid 是該文字伺服器擁有的有效資源,則返回 true。
bool _has_feature(feature: Feature) virtual required const 🔗
如果伺服器支援某個功能,則返回 true。
int _is_confusable(string: String, dict: PackedStringArray) virtual const 🔗
Returns index of the first string in dict which is visually confusable with the string, or -1 if none is found.
bool _is_locale_right_to_left(locale: String) virtual const 🔗
如果區域設定為從右至左,則返回 true。
bool _is_locale_using_support_data(locale: String) virtual const 🔗
Returns true if the locale requires text server support data for line/word breaking.
bool _is_valid_identifier(string: String) virtual const 🔗
Returns true if string is a valid identifier.
bool _is_valid_letter(unicode: int) virtual const 🔗
There is currently no description for this method. Please help us by contributing one!
bool _load_support_data(filename: String) virtual 🔗
Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
int _name_to_tag(name: String) virtual const 🔗
Converts the given readable name of a feature, variation, script, or language to an OpenType tag.
String _parse_number(number: String, language: String) virtual const 🔗
已棄用: Use TranslationServer.parse_number() instead.
Converts number from the numeral system used in the given language to Western Arabic (0..9).
If language is an empty string, the active locale will be used.
Array[Vector3i] _parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) virtual const 🔗
Default implementation of the BiDi algorithm override function.
String _percent_sign(language: String) virtual const 🔗
已棄用: Use TranslationServer.get_percent_sign() instead.
Returns percent sign used in the given language.
void _reference_oversampling_level(oversampling: float) virtual 🔗
Increases the reference count of the specified oversampling level. This method is called by Viewport, and should not be used directly.
bool _save_support_data(filename: String) virtual const 🔗
Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
int _shaped_get_run_count(shaped: RID) virtual const 🔗
Returns the number of uniform text runs in the buffer.
Direction _shaped_get_run_direction(shaped: RID, index: int) virtual const 🔗
Returns the direction of the index text run (in visual order).
RID _shaped_get_run_font_rid(shaped: RID, index: int) virtual const 🔗
Returns the font RID of the index text run (in visual order).
int _shaped_get_run_font_size(shaped: RID, index: int) virtual const 🔗
Returns the font size of the index text run (in visual order).
Vector2i _shaped_get_run_glyph_range(shaped: RID, index: int) virtual const 🔗
Returns the glyph range of the index text run (in visual order).
String _shaped_get_run_language(shaped: RID, index: int) virtual const 🔗
Returns the language of the index text run (in visual order).
Variant _shaped_get_run_object(shaped: RID, index: int) virtual const 🔗
Returns the embedded object of the index text run (in visual order).
Vector2i _shaped_get_run_range(shaped: RID, index: int) virtual const 🔗
Returns the source text range of the index text run (in visual order).
String _shaped_get_run_text(shaped: RID, index: int) virtual const 🔗
Returns the source text of the index text run (in visual order).
int _shaped_get_span_count(shaped: RID) virtual required const 🔗
Returns number of text spans added using _shaped_text_add_string() or _shaped_text_add_object().
Variant _shaped_get_span_embedded_object(shaped: RID, index: int) virtual required const 🔗
Returns text embedded object key.
Variant _shaped_get_span_meta(shaped: RID, index: int) virtual required const 🔗
返回文字區間的中繼資料。
Variant _shaped_get_span_object(shaped: RID, index: int) virtual required const 🔗
Returns the text span embedded object key.
String _shaped_get_span_text(shaped: RID, index: int) virtual required const 🔗
Returns the text span source text.
String _shaped_get_text(shaped: RID) virtual required const 🔗
Returns the text buffer source text, including object replacement characters.
void _shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary) virtual required 🔗
Changes text span font, font size, and OpenType features, without changing the text.
bool _shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, length: int, baseline: float) virtual required 🔗
向文字緩衝中新增行內物件,key 必須唯一。在文字中,物件使用 length 個物件替換字元表示。
bool _shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary, language: String, meta: Variant) virtual required 🔗
新增文字區間和字形,將其繪製到文字緩衝中。
void _shaped_text_clear(shaped: RID) virtual required 🔗
清空文字緩衝(移除文字和行內物件)。
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, oversampling: float) virtual const 🔗
Draw shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
void _shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, outline_size: int, color: Color, oversampling: float) virtual const 🔗
Draw the outline of the shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
RID _shaped_text_duplicate(shaped: RID) virtual required 🔗
Duplicates shaped text buffer.
float _shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag]) virtual 🔗
兩端對齊文字以適合指定寬度,返回新的文字寬度。
float _shaped_text_get_ascent(shaped: RID) virtual required const 🔗
返回該文字的升部(水平排版時為基線上方的圖元數,垂直排版時為基線左側的圖元數)。
void _shaped_text_get_carets(shaped: RID, position: int, r_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 🔗
Returns ellipsis character used for text clipping.
String _shaped_text_get_custom_punctuation(shaped: RID) virtual const 🔗
返回自訂標點字元列表,用於斷字。如果被設定為空字串,則使用服務的預設值。
float _shaped_text_get_descent(shaped: RID) virtual required 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 required const 🔗
返回省略號中的字形數。
const Glyph* _shaped_text_get_ellipsis_glyphs(shaped: RID) virtual required const 🔗
返回省略號中的字形陣列。
int _shaped_text_get_ellipsis_pos(shaped: RID) virtual required const 🔗
返回省略號的位置。
int _shaped_text_get_glyph_count(shaped: RID) virtual required const 🔗
返回緩衝區中的字形數。
const Glyph* _shaped_text_get_glyphs(shaped: RID) virtual required 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 required const 🔗
Returns the glyph index of the inline object.
Vector2i _shaped_text_get_object_range(shaped: RID, key: Variant) virtual required const 🔗
Returns the character range of the inline object.
Rect2 _shaped_text_get_object_rect(shaped: RID, key: Variant) virtual required const 🔗
返回行內對象的邊界矩形。
Array _shaped_text_get_objects(shaped: RID) virtual required const 🔗
返回行內物件的陣列。
Orientation _shaped_text_get_orientation(shaped: RID) virtual const 🔗
返回文字朝向。
RID _shaped_text_get_parent(shaped: RID) virtual required const 🔗
返回子字串源自哪個父緩衝區。
bool _shaped_text_get_preserve_control(shaped: RID) virtual const 🔗
如果文字緩衝區被配置為顯示控制字元,則返回 true。
bool _shaped_text_get_preserve_invalid(shaped: RID) virtual const 🔗
Returns true if text buffer is configured to display hexadecimal codes in place of invalid characters.
Vector2i _shaped_text_get_range(shaped: RID) virtual required const 🔗
返回父緩衝區中子字串緩衝區的字元範圍。
PackedVector2Array _shaped_text_get_selection(shaped: RID, start: int, end: int) virtual const 🔗
返回用於指定字元範圍的選區矩形。
Vector2 _shaped_text_get_size(shaped: RID) virtual required const 🔗
返回該文字的大小。
int _shaped_text_get_spacing(shaped: RID, spacing: SpacingType) virtual const 🔗
返回字形或行之間新增的額外間距,單位為圖元。
int _shaped_text_get_trim_pos(shaped: RID) virtual required const 🔗
返回超出修剪的位置。
float _shaped_text_get_underline_position(shaped: RID) virtual required const 🔗
返回基線下方底線的圖元偏移。
float _shaped_text_get_underline_thickness(shaped: RID) virtual required const 🔗
返回底線的粗細度。
float _shaped_text_get_width(shaped: RID) virtual required const 🔗
返回文字的寬度(對於水平排版)或高度(對於垂直排版)。
PackedInt32Array _shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag], skip_grapheme_flags: BitField[GraphemeFlag]) virtual const 🔗
Breaks text into words and returns array of character ranges. Use grapheme_flags to set what characters are used for breaking.
bool _shaped_text_has_object(shaped: RID, key: Variant) virtual required const 🔗
Returns true if an object with key is embedded in this shaped text buffer.
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 required 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 required 🔗
設定內嵌物件的新大小和對齊方式。
void _shaped_text_set_bidi_override(shaped: RID, override: Array) virtual 🔗
Overrides BiDi for the structured text.
void _shaped_text_set_custom_ellipsis(shaped: RID, char: int) virtual 🔗
Sets ellipsis character used for text clipping.
void _shaped_text_set_custom_punctuation(shaped: RID, punct: String) virtual 🔗
設定自訂標點字元列表,用於斷字。如果被設定為空字串,則使用服務的預設值。
void _shaped_text_set_direction(shaped: RID, direction: Direction) virtual 🔗
Sets desired text direction. If set to TextServer.DIRECTION_AUTO, direction will be detected based on the buffer contents and current locale.
void _shaped_text_set_orientation(shaped: RID, orientation: Orientation) virtual 🔗
Sets desired text orientation.
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 required 🔗
Shapes buffer if it's not shaped. Returns true if the string is shaped successfully.
const Glyph* _shaped_text_sort_logical(shaped: RID) virtual required 🔗
按邏輯順序返回文字字形。
RID _shaped_text_substr(shaped: RID, start: int, length: int) virtual required const 🔗
返回 shaped 文字緩衝區中字串的子字串的文字緩衝區(包括行內對象)。
float _shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) virtual 🔗
將塑形文字與給定的定位停駐點對齊。
bool _shaped_text_update_breaks(shaped: RID) virtual 🔗
Updates break points in the shaped text. This method is called by default implementation of text breaking functions.
bool _shaped_text_update_justification_ops(shaped: RID) virtual 🔗
Updates justification points in the shaped text. This method is called by default implementation of text justification functions.
bool _spoof_check(string: String) virtual const 🔗
Returns true if string is likely to be an attempt at confusing the reader.
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 🔗
Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even.
String _string_to_lower(string: String, language: String) virtual const 🔗
Returns the string converted to lowercase.
String _string_to_title(string: String, language: String) virtual const 🔗
Returns the string converted to Title Case.
String _string_to_upper(string: String, language: String) virtual const 🔗
Returns the string converted to UPPERCASE.
String _strip_diacritics(string: String) virtual const 🔗
Strips diacritics from the string.
String _tag_to_name(tag: int) virtual const 🔗
Converts the given OpenType tag to the readable name of a feature, variation, script, or language.
void _unreference_oversampling_level(oversampling: float) virtual 🔗
Decreases the reference count of the specified oversampling level, and frees the font cache for oversampling level when the reference count reaches zero. This method is called by Viewport, and should not be used directly.