![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IText property interface.
This interface represents a generic way to describe an object used for text output.
Get a constant Graph::IFontResourceTarget container. This method returns a constant pointer to a Graph::IFontResourceTarget container, which allows to query the font resources referenced by a node implementing this interface.
Murl.Graph.IGenericResourceTarget.ResourceIFont GetFontResourceTarget()
Set the ID of the system font used to render the text.
Boolean SetSystemFontName(String fontName)
fontName | A valid system font name, e.g. "SansBold". |
Get the ID of the system font used to render the text.
String GetSystemFontName()
Set the type of font used for rendering. If not specified, the actual font type is retrieved from the given values for either system font name or the font resource. Once initialized, the node's font type cannot be changed anymore.
Boolean SetFontType(Murl.IEnums.FontType fontType)
fontType | The font type. |
Get the type of font used for rendering.
Murl.IEnums.FontType GetFontType()
Set the font size.
Boolean SetFontSize(Number fontSize)
fontSize | The font size in system units. |
Get the font size.
Number GetFontSize()
Set the foreground (text) color used for rendering the text.
Boolean SetTextColor(Murl.Color textColor)
textColor | The text color. |
Get the text color.
Murl.Color GetTextColor()
Set the background color used for rendering.
Boolean SetBackgroundColor(Murl.Color backgroundColor)
backgroundColor | The background color. |
Get the background color.
Murl.Color GetBackgroundColor()
Get the optional constant Graph::ITextNodeTarget parent container. This method returns a constant pointer to a Graph::ITextNodeTarget container, which allows to query the parent text node that is used as a source for the displayed text.
Murl.Graph.IGenericNodeTarget.GraphIText GetParentTextNodeTarget()
Get the optional constant output Graph::ITextureNodeTarget container. This method returns a constant pointer to a Graph::ITextureNodeTarget container, which allows to query the texture node that is used as an optional output surface for the displayed text.
Murl.Graph.IGenericNodeTarget.GraphITexture GetOutputTextureNodeTarget()
Get a constant Graph::ITextResourceTarget container. This method returns a constant pointer to a Graph::ITextResourceTarget container, which allows to query the text resources referenced by a node implementing this interface.
Murl.Graph.IGenericResourceTarget.ResourceIText GetTextResourceTarget()
Set the text to be displayed.
text | A string containing the text to be displayed. |
Get the displayed text.
String GetText()
Enable/disable a given text hint.
Boolean SetTextHintEnabled(Murl.IEnums.TextHint hint, Boolean enabled)
hint | The hint to enable or disable |
enabled | If true, the given hint gets enabled. |
Check if a given trigger condition is enabled.
Boolean IsTextHintEnabled(Murl.IEnums.TextHint hint)
hint | The hint to check. |
Set the character spacing value. This method sets the character spacing used for output, i.e. the horizontal distance between neighbored characters. The given spacing value adds to the default value specified in the font used for rendering this text; a value of 0.0 represents the font's original spacing, a positive value increases the horizontal distance between characters, and a negative value decreases it.
Note: The given spacing value is not scaled by the font used; if e.g. a positive value is used for a large font, the same value used with a smaller version of that same font will result in a (relatively) larger distance between characters. It is however influenced by a possible additional scaling operation performed by a text rendering object.
Boolean SetSpacing(Number spacing)
spacing | The character spacing value. |
Get the character spacing value.
Number GetSpacing()
Set the leading value. This method sets the leading value used for output, i.e. the vertical distance between subsequent text lines. The given leading value adds to the default value specified in the font used for rendering this text; a value of 0.0 represents the font's original leading, a positive value increases the vertical distance between lines, and a negative value decreases it.
Note: The given leading value is not scaled by the font used; if e.g. a positive value is used for a large font, the same value used with a smaller version of that same font will result in a (relatively) larger distance between lines. It is however influenced by a possible additional scaling operation performed by a text rendering object.
Boolean SetLeading(Number leading)
leading | The leading value. |
Get the leading value.
Number GetLeading()
Set the embolding strength value. The embolding strength determines the "boldness" or "weight" of the font's rendered glyphs. Positive values result in thicker lines, and negative values can be used to make the font "thinner". Useful values are in the range from -1 to +1, but can also lie beyond that range.
Note that not all types of fonts allow glyph embolding. If not supported, this method returns false.
Boolean SetEmbolding(Number strength)
strength | The embolding strength value. |
Get the embolding strength value.
Number GetEmbolding()
Set the blur strength value.
Boolean SetBlur(Number strength)
strength | The positive blur strength value. |
Get the blur strength value.
Number GetBlur()
Set the space width factor. This method sets a factor used to control the actual width of the white space character. In some cases, it is useful to manually control the space character's width, when a font's default space width produces too small or too big a distance between subsequent words. A space width factor of 1.0 represents the original width defined by the font used for rendering.
Boolean SetSpaceWidthFactor(Number factor)
factor | The space width factor. |
Get the space width factor.
Number GetSpaceWidthFactor()
Set the digit width factor. This method sets a factor used to control the horizontal advance of all digit characters of a font ('0'-'9'). A digit width factor of 1.0 represents the original width defined by the font used for rendering.
Note, that this value only influences distance and not visual width; a value of e.g. 0.1 will result in overlapping digits without actually scaling them.
Boolean SetDigitWidthFactor(Number factor)
factor | The digit width factor. |
Get the digit width factor.
Number GetDigitWidthFactor()
Enable/disable unified digit width. For certain use cases, such as a score counter in an action game, it is useful to set a common width for all digits ('0'-'9'); doing so prevents the counter from jittering due to different digit widths.
Boolean SetSameDigitWidthEnabled(Boolean enabled)
enabled | If true, all digits use the same horizontal advance value. |
Check if unified digit width is enabled.
Boolean IsSameDigitWidthEnabled()
Enable/disable word wrapping.
Boolean SetWordWrappingEnabled(Boolean enabled)
enabled | If true, word wrapping is enabled. |
Check if word wrapping is enabled.
Boolean IsWordWrappingEnabled()
Set the horizontal text alignment.
Boolean SetTextAlignmentX(Murl.IEnums.TextAlignmentX alignment)
alignment | The horizontal text alignment. |
Get the horizontal text alignment.
Murl.IEnums.TextAlignmentX GetTextAlignmentX()
Set the vertical text alignment.
Boolean SetTextAlignmentY(Murl.IEnums.TextAlignmentY alignment)
alignment | The vertical text alignment. |
Get the vertical text alignment.
Murl.IEnums.TextAlignmentY GetTextAlignmentY()
Query the dimensions of a given UTF8 text.
Boolean, Number, Number QueryTextSize(String text, Number sizeX, Number sizeY)
text | The text to query |
sizeX | A reference to a Real variable receiving the horizontal text size. |
sizeY | A reference to a Real variable receiving the vertical text size. |