Displays text-based menus, for use with a keyboard. More...

Detailed Description

Displays text-based menus, for use with a keyboard.

The text of the menu is defined inside titles.txt, powered by the same backend handling Game Text.

It is also used for things such as the waypoint editor. What the menu looks like can be seen here:

Waypoint Editor powered by Text Menus

Console Commands

textMenuOpen [TITLE]

Will display the text named TITLE. If a file named decls/textmenu/TITLE.decl exists, it'll map the input codes to command entries named in the file.

Such a decl can look like this:

typeInfo commands
{
    "1" "say Hello World"
    "2" "play sound/enforcer/enfstop.wav"
    "3" "toggle r_showshaders"
    "5" "textMenuOpen MENUTEST2"
    "9" "textMenuClose"
}

textMenuClose

When issued, will close/hide whatever text menu may have been open at this time.

Classes
class	ncTextMenuDict

Functions
void	Textmenu_Call (string)
	Forcefully displays a given text menu. More...

void	Textmenu_Toggle (string)
	Toggle the text menu, replacing it with the one specified if inactive. More...

int	Textmenu_IsActive (void)
	Returns `true` or `false` depending on if a text menu is currently active. More...

void	Textmenu_Hide (void)
	Force the active text menu to be hidden. More...

void	Textmenu_Input (int)
	Called by Nuclide to pass numeric input values to the text menu. More...

void	Textmenu_Draw (void)
	Called by Nuclide to draw text menus. More...

bool	Textmenu_Open (string defName)
	Called by `textMenuCreate` console command, argument equals the decl name. More...

Variables
ncTextMenuDict	g_textMenuDict

Function Documentation

◆ Textmenu_Call()

void Textmenu_Call ( string menu )

Forcefully displays a given text menu.

◆ Textmenu_Draw()

void Textmenu_Draw ( void )

Called by Nuclide to draw text menus.

◆ Textmenu_Hide()

void Textmenu_Hide ( void )

Force the active text menu to be hidden.

◆ Textmenu_Input()

void Textmenu_Input ( int nr )

Called by Nuclide to pass numeric input values to the text menu.

◆ Textmenu_IsActive()

int Textmenu_IsActive ( void )

Returns true or false depending on if a text menu is currently active.

◆ Textmenu_Open()

bool Textmenu_Open ( string defName )

Called by textMenuCreate console command, argument equals the decl name.

◆ Textmenu_Toggle()

void Textmenu_Toggle ( string menu )

Toggle the text menu, replacing it with the one specified if inactive.

Variable Documentation

◆ g_textMenuDict

ncTextMenuDict g_textMenuDict