The "vngen_label_replace_ext" Function

Syntax

vngen_label_replace_ext(id, label, xorig, yorig, scaling, linebreak, font, color, duration, ease, [lang]);
ArgumentTypeDescription
idreal/stringThe ID of the label to replace
labelstring/macroThe text string to display as a label (or keyword auto for speaker names)
xorigreal/macroThe horizontal texture offset, or origin point, relative to the top-left corner
yorigreal/macroThe vertical texture offset, or origin point, relative to the top-left corner
scalinginteger/macroSets the automatic scaling mode for the label
linebreakrealThe width in pixels before text is wrapped into a new line
fontfont/macroThe font to draw text in, where fnt_default is default (or keyword previous for no change, or keyword inherit for saved style)
colorcolor/macroThe color to draw text in, where c_white is default (or keyword previous for no change, or keyword inherit for saved style)
durationrealSets the duration of the fade transition, in seconds
easeinteger/macroSets the ease mode to perform the transition in
[lang]real/stringOptional: Sets the language flag for the label

Description

Replaces the input entity ID with extra options and fades the old label to the new one over the input duration.

As with other types of modifications, replacements made with this script are permanent and will persist until another replacement is performed. This script cannot be performed simultaneously with other replacement actions operating on the same entity ID.

Note that labels are displayed as a surface, or texture, and the exact dimensions of this texture may not be known. As a result, functions like xorig, yorig, and scaling may not behave as expected. It is important to test your label actions and design your fonts and linebreaks to a standard which results in predictable texture dimensions.

See Macros & Keywords for a list of available style modes and transition animations. See Language Functions for details on multi-language support.

Example

vngen_event() {
vngen_label_replace("label", auto, orig_left, orig_top, scale_none, 384, previous, inherit, 3, ease_sin_out);
vngen_label_replace("label", "John Doe", orig_left, orig_top, scale_none, 384, fnt_Arial, c_white, 3, ease_sin_out, "en-US");
}