ILineLocalisationProvider.GetLocalisedTextForLine Method

Returns the user-facing text for a given Line.

string GetLocalisedTextForLine(Line line)

Remarks

This method determines the final text to deliver to the user, given a Line. Classes that implement this method should use the Line’s ID to look up the user-facing text in a string table, and then replace any substitutions and expand any format functions by calling ExpandFormatFunctions(String, String).

See the Line class’s documentation for more information on how to prepare a Line for delivery to the user.

Parameters

Parameter Description
Line line The Line to get the text for.

Return Type

string: The text to show the user, or null if the user-facing text cannot be found.

See Also