Lua API

GUI module

Functions for manipulating the player's user interface.

Usage

local GUI = ELONA.require("core.GUI")

Functions

txt (message) Prints some text in the HUD message window.
txt (message, color) Prints some text in the HUD message window.
txtnew () Starts a new message line in the HUD message window.
play_sound (sound_id) Plays a sound.
show_journal_update_message () Displays the journal update message.
fade_out () Fades out the screen, then fades it in.

Functions

# txt (message)

Prints some text in the HUD message window.

Parameters:
  • message : (string) the message to print
# txt (message, color)

Prints some text in the HUD message window.

Parameters:
  • message : (string) the message to print
  • color : (Color) of the message
# txtnew ()

Starts a new message line in the HUD message window.

# play_sound (sound_id)

Plays a sound.

Parameters:
  • sound_id : (string) The sound, of type core.sound
# show_journal_update_message ()

Displays the journal update message.

# fade_out ()

Fades out the screen, then fades it in.