TextCurve(Curve)

base classes — bpy_struct, ID, Curve

class bpy.types.TextCurve(Curve)

Curve data-block used for storing text

active_textbox

(in [-inf, inf], default 0)

Type:

int

align_x

Text horizontal alignment from the object or text box center (default 'LEFT')

  • LEFT Left – Align text to the left.

  • CENTER Center – Center text.

  • RIGHT Right – Align text to the right.

  • JUSTIFY Justify – Align to the left and the right.

  • FLUSH Flush – Align to the left and the right, with equal character spacing.

Type:

Literal[‘LEFT’, ‘CENTER’, ‘RIGHT’, ‘JUSTIFY’, ‘FLUSH’]

align_y

Text vertical alignment from the object center (default 'TOP_BASELINE')

  • TOP Top – Align text to the top.

  • TOP_BASELINE Top Baseline – Align text to the top line’s baseline.

  • CENTER Middle – Align text to the middle.

  • BOTTOM_BASELINE Bottom Baseline – Align text to the bottom line’s baseline.

  • BOTTOM Bottom – Align text to the bottom.

Type:

Literal[‘TOP’, ‘TOP_BASELINE’, ‘CENTER’, ‘BOTTOM_BASELINE’, ‘BOTTOM’]

body

Content of this text object (default “”, never None)

Type:

str

body_format

Stores the style of each character (default None, readonly)

Type:

bpy_prop_collection[TextCharacterFormat]

edit_format

Editing settings character formatting (readonly)

Type:

TextCharacterFormat

family

Use objects as font characters (give font objects a common name followed by the character they represent, eg. ‘family-a’, ‘family-b’, etc, set this setting to ‘family-’, and turn on Vertex Instancing) (default “”, never None)

Type:

str

follow_curve

Curve deforming text object

Type:

Object

font
Type:

VectorFont

font_bold
Type:

VectorFont

font_bold_italic
Type:

VectorFont

font_italic
Type:

VectorFont

has_selection

Whether there is any text selected (default False, readonly)

Type:

bool

is_select_bold

Whether the selected text is bold (default False, readonly)

Type:

bool

is_select_italic

Whether the selected text is italics (default False, readonly)

Type:

bool

is_select_smallcaps

Whether the selected text is small caps (default False, readonly)

Type:

bool

is_select_underline

Whether the selected text is underlined (default False, readonly)

Type:

bool

offset_x

Horizontal offset from the object origin (in [-inf, inf], default 0.0)

Type:

float

offset_y

Vertical offset from the object origin (in [-inf, inf], default 0.0)

Type:

float

overflow

Handle the text behavior when it does not fit in the text boxes (default 'NONE')

  • NONE Overflow – Let the text overflow outside the text boxes.

  • SCALE Scale to Fit – Scale down the text to fit inside the text boxes.

  • TRUNCATE Truncate – Truncate the text that would go outside the text boxes.

Type:

Literal[‘NONE’, ‘SCALE’, ‘TRUNCATE’]

shear

Italic angle of the characters (in [-1, 1], default 0.0)

Type:

float

size

(in [0.0001, 10000], default 1.0)

Type:

float

small_caps_scale

Scale of small capitals (in [-inf, inf], default 0.75)

Type:

float

space_character

(in [0, 10], default 1.0)

Type:

float

space_line

(in [0, 10], default 1.0)

Type:

float

space_word

(in [0, 10], default 1.0)

Type:

float

text_boxes

(default None, readonly)

Type:

bpy_prop_collection[TextBox]

underline_height

(in [0, 0.8], default 0.05)

Type:

float

underline_position

Vertical position of underline (in [-0.2, 0.8], default 0.0)

Type:

float

use_fast_edit

Don’t fill polygons while editing (default False)

Type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions