Text Elements

Functions

eg-overlay-ui.text(text2, color, fontpath, fontsize[, fontweight[, fontslant[, fontwidth]]])

Create a new uitext element.

Note

See Fonts for more detail on the font* parameters.

Parameters:

• text (string) – The text string to display.

• color (integer) – Text color. This is an integer value in RGBA format. See Colors.

• fontpath (string) – The path to the font to use.

• fontsize (integer) – The font size, expressed as a pixel height.

• fontweight (integer) – (Optional) The font weight.

• fontslant (integer) – (Optional) The font slant.

• fontwidth (integer) – (Optional) the font width.

Returns:

A text UI element

Version History

Version	Notes
0.0.1	Added

Classes

class eg-overlay-ui.uitext

A text element.

update_text(newtext)

Update the text displayed by this text element. It will be automatically resized.

Parameters:

newtext (string) – The new text to display.

Version History

Version	Notes
0.0.1	Added

addeventhandler(func)

Add an event handler for this UI element. See UI Events.

Parameters:

func (function)

Return type:

integer

Returns:

A id that can be used with removeeventhandler()

Version History

Version	Notes
0.1.0	Added

removeeventhandler(id)

Remove an event handler for this UI element.

Parameters:

id (integer)

Version History

Version	Notes
0.1.0	Added

events(value)

Set if this element should emit events or not. Defaults to false.

Parameters:

value (boolean)

Version History

Version	Notes
0.1.0	Added

background([color])

Set or retrieve background color. If a background color with an alpha value of 0 is specified, no background is drawn.

Parameters:

color (integer) – A color, see Colors.

Return type:

integer

Version History

Version	Notes
0.1.0	Added