The "sys_text_init" Function

Syntax

sys_text_init(entity, index, text, name, linebreak, lineheight, font, col1, col2, col3, col4, shadow, outline, speed);

Argument	Type	Description
entity	integer	The data structure of the text entity to process
index	integer	The index of the row containing the target entity
text	string	The text string to process
name	string	The speaker name associated with the text, for style inheritance
linebreak	real	The width in pixels before text is wrapped into a new line
lineheight	real	The distance between lines of text, as a multiplier of the height of one line
font	font	The font to process text in, where fnt_default is default
col1	color	The text top-left gradient color, where c_white is default
col2	color	The text top-right gradient color, where c_white is default
col3	color	The text bottom-right gradient color, where c_white is default
col4	color	The text bottom-left gradient color, where c_white is default
shadow	color/macro	The text shadow color, where 'none' is default
outline	color/macro	The text outline color, where 'none' is default
speed/event	real	The rate at which text is printed onto the screen, as a value of characters per-second

Description

Processes a string of text for markup and calculates dimensions on initialization. Also returns the final surface created for further processing. This script does not handle style inheritance, which must be processed externally beforehand and the final results passed into this script.

As this script is run automatically by any actions that require processing text, it is almost never necessary to run sys_text_init manually.