unreal.Text3DComponent

class unreal.Text3DComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: SceneComponent

Text 3DComponent

C++ Source:

  • Plugin: Text3D

  • Module: Text3D

  • File: Text3DComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • back_material (MaterialInterface): [Read-Write] Material for the back part

  • bevel (float): [Read-Write] Size of bevel

  • bevel_material (MaterialInterface): [Read-Write] Material for the bevel part

  • bevel_segments (int32): [Read-Write] Bevel Segments (Defines the amount of tesselation for the bevel part)

  • bevel_type (Text3DBevelType): [Read-Write] Bevel Type

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • cast_shadow (bool): [Read-Write] Controls whether the text glyphs should cast a shadow or not.

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • extrude (float): [Read-Write] Size of the extrude

  • extrude_material (MaterialInterface): [Read-Write] Material for the extruded part

  • font (Font): [Read-Write] Text font

  • front_material (MaterialInterface): [Read-Write] Material for the front part

  • has_max_height (bool): [Read-Write] Enables a maximum height to the 3D Text

  • has_max_width (bool): [Read-Write] Enables a maximum width to the 3D Text

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • horizontal_alignment (Text3DHorizontalTextAlignment): [Read-Write] Horizontal text alignment

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • kerning (float): [Read-Write] Text kerning

  • line_spacing (float): [Read-Write] Extra line spacing

  • max_height (float): [Read-Write] Sets a maximum height to the 3D Text

  • max_width (float): [Read-Write] Sets a maximum width to the 3D Text

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • outline (bool): [Read-Write] Generate Outline

  • outline_expand (float): [Read-Write] Outline expand/offset amount

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • refresh_on_change (bool): [Read-Write] Whether to allow automatic refresh/mesh generation

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • scale_proportionally (bool): [Read-Write] Should the mesh scale proportionally when Max Width/Height is set

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • text (Text): [Read-Write] The text to generate a 3d mesh

  • text_generated_delegate (TextGenerated): [Read-Write]

  • typeface (Name): [Read-Write]

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • vertical_alignment (Text3DVerticalTextAlignment): [Read-Write] Vertical text alignment

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

  • word_spacing (float): [Read-Write] Extra word spacing

property back_material: MaterialInterface

[Read-Write] Material for the back part

Type:

(MaterialInterface)

property bevel: float

[Read-Write] Size of bevel

Type:

(float)

property bevel_material: MaterialInterface

[Read-Write] Material for the bevel part

Type:

(MaterialInterface)

property bevel_segments: int

[Read-Write] Bevel Segments (Defines the amount of tesselation for the bevel part)

Type:

(int32)

property bevel_type: Text3DBevelType

[Read-Write] Bevel Type

Type:

(Text3DBevelType)

property cast_shadow: bool

[Read-Write] Controls whether the text glyphs should cast a shadow or not.

Type:

(bool)

property extrude: float

[Read-Write] Size of the extrude

Type:

(float)

property extrude_material: MaterialInterface

[Read-Write] Material for the extruded part

Type:

(MaterialInterface)

property font: Font

[Read-Write] Text font

Type:

(Font)

property front_material: MaterialInterface

[Read-Write] Material for the front part

Type:

(MaterialInterface)

get_bounds() -> (origin=Vector, box_extent=Vector)

Get Bounds

Returns:

origin (Vector):

box_extent (Vector):

Return type:

tuple

get_formatted_text() → Text

Returns the Text property, after being formatted by the FormatText virtual function. If FormatText is not overriden, the return FText will be the same as the Text property.

Return type:

Text

get_glyph_count() → int32

Gets the number of font glyphs that are currently used

Return type:

int32

get_glyph_kerning_component(index) → SceneComponent

Gets the USceneComponent that a glyph is attached to

Parameters:

index (int32) –

Return type:

SceneComponent

get_glyph_kerning_components() → Array[SceneComponent]

Gets all the glyph kerning components

Return type:

Array[SceneComponent]

get_glyph_mesh_component(index) → StaticMeshComponent

Gets the StaticMeshComponent of a glyph

Parameters:

index (int32) –

Return type:

StaticMeshComponent

get_glyph_mesh_components() → Array[StaticMeshComponent]

Gets all the glyph meshes

Return type:

Array[StaticMeshComponent]

get_text_scale() → Vector

Gets the scale of actual text geometry, taking into account MaxWidth and MaxHeight constraints. This function will NOT return the component scale

Return type:

Vector

property has_max_height: bool

[Read-Write] Enables a maximum height to the 3D Text

Type:

(bool)

property has_max_width: bool

[Read-Write] Enables a maximum width to the 3D Text

Type:

(bool)

property horizontal_alignment: Text3DHorizontalTextAlignment

[Read-Write] Horizontal text alignment

Type:

(Text3DHorizontalTextAlignment)

property kerning: float

[Read-Write] Text kerning

Type:

(float)

property line_spacing: float

[Read-Write] Extra line spacing

Type:

(float)

property max_height: float

[Read-Write] Sets a maximum height to the 3D Text

Type:

(float)

property max_width: float

[Read-Write] Sets a maximum width to the 3D Text

Type:

(float)

property outline: bool

[Read-Write] Generate Outline

Type:

(bool)

property outline_expand: float

[Read-Write] Outline expand/offset amount

Type:

(float)

property refresh_on_change: bool

[Read-Write] Whether to allow automatic refresh/mesh generation

Type:

(bool)

property scale_proportionally: bool

[Read-Write] Should the mesh scale proportionally when Max Width/Height is set

Type:

(bool)

set_back_material(value) → None

Set the text back material deprecated: Set the property directly

Parameters:

value (MaterialInterface) –

set_bevel(value) → None

Set the 3d bevel value deprecated: Set the property directly

Parameters:

value (float) –

set_bevel_material(value) → None

Set the text bevel material deprecated: Set the property directly

Parameters:

value (MaterialInterface) –

set_bevel_segments(value) → None

Set the amount of segments that will be used to tessellate the Bevel deprecated: Set the property directly

Parameters:

value (int32) –

set_bevel_type(value) → None

Set the 3d bevel type deprecated: Set the property directly

Parameters:

value (Text3DBevelType) –

set_cast_shadow(new_cast_shadow) → None

Set the value of CastShadow. deprecated: Set the property directly

Parameters:

new_cast_shadow (bool) –

set_extrude(value) → None

Set the text extrusion size and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (float) –

set_extrude_material(value) → None

Set the text extrude material deprecated: Set the property directly

Parameters:

value (MaterialInterface) –

set_font(font) → None

Set the text font and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

font (Font) –

set_freeze(freeze) → None

Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together deprecated: Set the property directly

Parameters:

freeze (bool) –

set_front_material(value) → None

Set the text front material deprecated: Set the property directly

Parameters:

value (MaterialInterface) –

set_has_max_height(value) → None

Enable / Disable a Maximum Height deprecated: Set the property directly

Parameters:

value (bool) –

set_has_max_width(value) → None

Enable / Disable a Maximum Width deprecated: Set the property directly

Parameters:

value (bool) –

set_has_outline(value) → None

Set whether an outline is applied. deprecated: Set the property directly

Parameters:

value (bool) –

set_horizontal_alignment(value) → None

Set the horizontal alignment value and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (Text3DHorizontalTextAlignment) –

set_kerning(value) → None

Set the kerning value and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (float) –

set_line_spacing(value) → None

Set the line spacing value and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (float) –

set_max_height(value) → None

Set the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value deprecated: Set the property directly

Parameters:

value (float) –

set_max_width(value) → None

Set the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value deprecated: Set the property directly

Parameters:

value (float) –

set_outline_expand(value) → None

Set the outline width. deprecated: Set the property directly

Parameters:

value (float) –

set_scale_proportionally(value) → None

Set if the mesh should scale proportionally when Max Width/Height is set deprecated: Set the property directly

Parameters:

value (bool) –

set_text(value) → None

Set the text value and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (Text) –

set_vertical_alignment(value) → None

Set the vertical alignment and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (Text3DVerticalTextAlignment) –

set_word_spacing(value) → None

Set the word spacing value and signal the primitives to be rebuilt deprecated: Set the property directly

Parameters:

value (float) –

property text: Text

[Read-Write] The text to generate a 3d mesh

Type:

(Text)

property text_generated_delegate: TextGenerated

[Read-Write]

Type:

(TextGenerated)

property typeface: Name

[Read-Write]

Type:

(Name)

property vertical_alignment: Text3DVerticalTextAlignment

[Read-Write] Vertical text alignment

Type:

(Text3DVerticalTextAlignment)

property word_spacing: float

[Read-Write] Extra word spacing

Type:

(float)