TextSequence(EffectSequence)#

base classes — bpy_struct, Sequence, EffectSequence

class bpy.types.TextSequence(EffectSequence)#

Sequence strip creating text

alignment_x#

Horizontal text alignment

Type:

enum in [‘LEFT’, ‘CENTER’, ‘RIGHT’], default ‘LEFT’

anchor_x#

Horizontal position of the text box relative to Location

Type:

enum in [‘LEFT’, ‘CENTER’, ‘RIGHT’], default ‘LEFT’

anchor_y#

Vertical position of the text box relative to Location

Type:

enum in [‘TOP’, ‘CENTER’, ‘BOTTOM’], default ‘TOP’

box_color#
Type:

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

box_margin#

Box margin as factor of image width

Type:

float in [0, 1], default 0.01

box_roundness#

Box corner radius as a factor of box height

Type:

float in [0, 1], default 0.0

color#

Text color

Type:

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

font#

Font of the text. Falls back to the UI font by default.

Type:

VectorFont

font_size#

Size of the text

Type:

float in [0, 2000], default 0.0

input_count#
Type:

int in [0, inf], default 0, (readonly)

location#

Location of the text

Type:

mathutils.Vector of 2 items in [-inf, inf], default (0.0, 0.0)

outline_color#
Type:

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

outline_width#
Type:

float in [0, 1], default 0.05

shadow_angle#
Type:

float in [0, 6.28319], default 1.13446

shadow_blur#
Type:

float in [0, 1], default 0.0

shadow_color#
Type:

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

shadow_offset#
Type:

float in [0, 1], default 0.04

text#

Text that will be displayed

Type:

string, default “”, (never None)

use_bold#

Display text as bold

Type:

boolean, default False

use_box#

Display colored box behind text

Type:

boolean, default False

use_italic#

Display text as italic

Type:

boolean, default False

use_outline#

Display outline around text

Type:

boolean, default False

use_shadow#

Display shadow behind text

Type:

boolean, default False

wrap_width#

Word wrap width as factor, zero disables

Type:

float in [0, inf], default 0.0

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

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

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

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#