Struct TextMesh

#[repr(C)]
pub struct TextMesh { /* private fields */ }

Expand description

Godot class TextMesh.

Inherits PrimitiveMesh.

Related symbols:

ITextMesh: virtual methods

§Construction

This class is reference-counted. You can create a new instance using TextMesh::new_gd().

Implementations§

§

impl TextMesh

pub fn set_horizontal_alignment(&mut self, alignment: HorizontalAlignment)

pub fn get_horizontal_alignment(&self) -> HorizontalAlignment

pub fn set_vertical_alignment(&mut self, alignment: VerticalAlignment)

pub fn get_vertical_alignment(&self) -> VerticalAlignment

pub fn set_text(&mut self, text: impl AsArg<GString>)

pub fn get_text(&self) -> GString

pub fn set_font(&mut self, font: impl AsObjectArg)

pub fn get_font(&self) -> Option<Gd>

pub fn set_font_size(&mut self, font_size: i32)

pub fn get_font_size(&self) -> i32

pub fn set_line_spacing(&mut self, line_spacing: f32)

pub fn get_line_spacing(&self) -> f32

pub fn set_autowrap_mode(&mut self, autowrap_mode: AutowrapMode)

pub fn get_autowrap_mode(&self) -> AutowrapMode

pub fn set_justification_flags( &mut self, justification_flags: JustificationFlag, )

pub fn get_justification_flags(&self) -> JustificationFlag

pub fn set_depth(&mut self, depth: f32)

pub fn get_depth(&self) -> f32

pub fn set_width(&mut self, width: f32)

pub fn get_width(&self) -> f32

pub fn set_pixel_size(&mut self, pixel_size: f32)

pub fn get_pixel_size(&self) -> f32

pub fn set_offset(&mut self, offset: Vector2)

pub fn get_offset(&self) -> Vector2

pub fn set_curve_step(&mut self, curve_step: f32)

pub fn get_curve_step(&self) -> f32

pub fn set_text_direction(&mut self, direction: Direction)

pub fn get_text_direction(&self) -> Direction

pub fn set_language(&mut self, language: impl AsArg<GString>)

pub fn get_language(&self) -> GString

pub fn set_structured_text_bidi_override( &mut self, parser: StructuredTextParser, )

pub fn get_structured_text_bidi_override(&self) -> StructuredTextParser

pub fn set_structured_text_bidi_override_options( &mut self, args: &Array<Variant>, )

pub fn get_structured_text_bidi_override_options(&self) -> Array<Variant>

pub fn set_uppercase(&mut self, enable: bool)

pub fn is_uppercase(&self) -> bool

Methods from Deref<Target = PrimitiveMesh>§

pub fn set_material(&mut self, material: impl AsObjectArg<Material>)

pub fn get_material(&self) -> Option<Gd<Material>>

pub fn get_mesh_arrays(&self) -> Array<Variant>

pub fn set_custom_aabb(&mut self, aabb: Aabb)

pub fn get_custom_aabb(&self) -> Aabb

pub fn set_flip_faces(&mut self, flip_faces: bool)

pub fn get_flip_faces(&self) -> bool

pub fn set_add_uv2(&mut self, add_uv2: bool)

pub fn get_add_uv2(&self) -> bool

pub fn set_uv2_padding(&mut self, uv2_padding: f32)

pub fn get_uv2_padding(&self) -> f32

pub fn request_update(&mut self)

Methods from Deref<Target = Mesh>§

pub fn set_lightmap_size_hint(&mut self, size: Vector2i)

pub fn get_lightmap_size_hint(&self) -> Vector2i

pub fn get_aabb(&self) -> Aabb

pub fn get_faces(&self) -> PackedVector3Array

pub fn get_surface_count(&self) -> i32

pub fn surface_get_arrays(&self, surf_idx: i32) -> Array<Variant>

pub fn surface_get_blend_shape_arrays( &self, surf_idx: i32, ) -> Array<Array<Variant>>

pub fn surface_set_material( &mut self, surf_idx: i32, material: impl AsObjectArg<Material>, )

pub fn surface_get_material(&self, surf_idx: i32) -> Option<Gd<Material>>

pub fn create_placeholder(&self) -> Option<Gd<Resource>>

pub fn create_trimesh_shape(&self) -> Option<Gd<ConcavePolygonShape3D>>

pub fn create_convex_shape(&self) -> Option<Gd<ConvexPolygonShape3D>>

To set the default parameters, use Self::create_convex_shape_ex and its builder methods. See the book for detailed usage instructions.

pub fn create_convex_shape_ex<'a>(&'a self) -> ExCreateConvexShape<'a>

pub fn create_outline(&self, margin: f32) -> Option<Gd<Mesh>>

pub fn generate_triangle_mesh(&self) -> Option<Gd<TriangleMesh>>

Methods from Deref<Target = Resource>§

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.