Module menu

Implements the subtitle menu GUI.

Functions

subtitles.get_menu_formspec (player, embedded, options) Creates a menu formspec for the specified player.
subtitles.show_menu (player) Shows the subtitle menu to the specified player.
subtitles.menu_receive_fields (player, fields, embedded) Handles receiving fields from the menu formspec.


Functions

subtitles.get_menu_formspec (player, embedded, options)
Creates a menu formspec for the specified player.

Parameters:

  • player The username or ObjectRef of the player.
  • embedded This should be true if the menu is being embedded in another formspec.
  • options A table of extra options: width, height.

Returns:

    A formspec string.
subtitles.show_menu (player)
Shows the subtitle menu to the specified player.

Parameters:

  • player The username or ObjectRef of the player.
subtitles.menu_receive_fields (player, fields, embedded)
Handles receiving fields from the menu formspec.

Parameters:

  • player The username or ObjectRef of the player.
  • fields A table of fields.
  • embedded If this is true, the menu will not be re-shown.
generated by LDoc 1.4.6 Last updated 2023-01-14 06:51:17