TextStrip(EffectStrip)

base classes — bpy_struct, Strip, EffectStrip

class bpy.types.TextStrip(EffectStrip)

Sequence strip creating text

alignment_x

Horizontal text alignment (default 'LEFT')

Type:

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

anchor_x

Horizontal position of the text box relative to Location (default 'LEFT')

Type:

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

anchor_y

Vertical position of the text box relative to Location (default 'TOP')

Type:

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

box_color

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

Type:

bpy_prop_array[float]

box_margin

Box margin as factor of image width (in [0, 1], default 0.01)

Type:

float

box_roundness

Box corner radius as a factor of box height (in [0, 1], default 0.0)

Type:

float

color

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

Type:

bpy_prop_array[float]

font

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

Type:

VectorFont

font_size

Size of the text (in [0, 2000], default 0.0)

Type:

float

input_count

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

Type:

int

location

Location of the text (array of 2 items, in [-inf, inf], default (0.0, 0.0))

Type:

mathutils.Vector

outline_color

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

Type:

bpy_prop_array[float]

outline_width

(in [0, 1], default 0.05)

Type:

float

shadow_angle

(in [0, 6.28319], default 1.13446)

Type:

float

shadow_blur

(in [0, 1], default 0.0)

Type:

float

shadow_color

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

Type:

bpy_prop_array[float]

shadow_offset

(in [0, 1], default 0.04)

Type:

float

text

Text that will be displayed (default “”, never None)

Type:

str

use_bold

Display text as bold (default False)

Type:

bool

use_box

Display colored box behind text (default False)

Type:

bool

use_italic

Display text as italic (default False)

Type:

bool

use_outline

Display outline around text (default False)

Type:

bool

use_shadow

Display shadow behind text (default False)

Type:

bool

wrap_width

Word wrap width as factor, zero disables (in [0, inf], default 0.0)

Type:

float

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