Diagnostic and developer menu system. More...

Static Public Member Functions
static proto void	RegisterMenu (int id, string name, string parent)
	Registers a new menu.

static proto void	RegisterItem (int id, string shortcut, string name, string parent, string values)
	Registers a new item in a menu.

static proto void	Unregister (int id)
	Unregisters a menu or item by id.

static proto void	RegisterBool (int id, string shortcut, string name, string parent, bool reverse=false)
	Registers a boolean setting.

static proto void	RegisterRange (int id, string shortcut, string name, string parent, string valuenames)
	Registers a range-setting menu item.

static proto bool	GetBool (int id, bool reverse=false)
	Gets the value of a boolean item.

static proto int	GetValue (int id)
	Gets the value of an integer menu item.

static proto void	SetValue (int id, int value)
	Sets an integer value for an item.

static proto float	GetRangeValue (int id)
	Gets the floating-point value for a range item.

static proto void	SetRangeValue (int id, float value)
	Sets the floating-point value for a range item.

static proto void	SetEngineValue (int id, int value)
	Sets an engine value directly.

static proto int	GetEngineValue (int id)
	Gets an engine integer value.

static proto void	SetEngineRangeValue (int id, float value)
	Sets an engine float value for a range item.

static proto float	GetEngineRangeValue (int id)
	Gets an engine float value for a range item.

static proto void	SelectMenuByName (string name)
	Selects a menu by its name.

static proto void	SelectMenuById (int id)
	Selects a menu by its id.

Detailed Description

Diagnostic and developer menu system.

Note: Check EDiagMenu enum for 'id' values \

Member Function Documentation

◆ GetBool()

static proto bool DiagMenu.GetBool	(	int	id,
		bool	reverse = false )

static

Gets the value of a boolean item.

Parameters

id	Boolean item identifier.
reverse	If true, the value is logically inverted.

Returns: Boolean value (true or false).

◆ GetEngineRangeValue()

static proto float DiagMenu.GetEngineRangeValue ( int id )

static

Gets an engine float value for a range item.

Parameters

id	Identifier.

Returns: Float value.

◆ GetEngineValue()

static proto int DiagMenu.GetEngineValue ( int id )

static

Gets an engine integer value.

Parameters

id	Identifier.

Returns: Integer value.

◆ GetRangeValue()

static proto float DiagMenu.GetRangeValue ( int id )

static

Gets the floating-point value for a range item.

Parameters

id	Range item identifier.

Returns: Current float value.

◆ GetValue()

static proto int DiagMenu.GetValue ( int id )

static

Gets the value of an integer menu item.

Parameters

id	Item identifier.

Returns: Integer value.

◆ RegisterBool()

static proto void DiagMenu.RegisterBool	(	int	id,
		string	shortcut,
		string	name,
		string	parent,
		bool	reverse = false )

static

Registers a boolean setting.

Parameters

id	Unique identifier.
shortcut	Shortcut key(s), e.g. "lctrl+lshift+f"; supported keys: lctrl, rctrl, lshift, rshift, shift, lalt, ralt, a-z, 0-9, num0-num9, f1-f12.
name	Display name for the boolean item.
parent	Parent menu name.
reverse	If true, the boolean sense is inverted.

◆ RegisterItem()

static proto void DiagMenu.RegisterItem	(	int	id,
		string	shortcut,
		string	name,
		string	parent,
		string	values )

static

Registers a new item in a menu.

Parameters

id	Unique item identifier.
shortcut	Shortcut key(s), e.g. "lctrl+lshift+f"; supported keys: lctrl, rctrl, lshift, rshift, shift, lalt, ralt, a-z, 0-9, num0-num9, f1-f12.
name	Item name.
parent	Parent menu name.
values	List of possible values for the item.

◆ RegisterMenu()

static proto void DiagMenu.RegisterMenu	(	int	id,
		string	name,
		string	parent )

static

Registers a new menu.

Parameters

id	Unique menu identifier.
name	Menu name.
parent	Parent menu name.

◆ RegisterRange()

static proto void DiagMenu.RegisterRange	(	int	id,
		string	shortcut,
		string	name,
		string	parent,
		string	valuenames )

static

Registers a range-setting menu item.

Range value is defined as "min,max,startValue,step". E.g. "-2, 2, 0, 0.1" creates a variable in range [-2,2], starting at 0, step size 0.1.

Parameters

id	Unique identifier.
shortcut	Shortcut key(s), e.g. "lctrl+lshift+f"; supported keys: lctrl, rctrl, lshift, rshift, shift, lalt, ralt, a-z, 0-9, num0-num9, f1-f12.
name	Display name.
parent	Parent menu name.
valuenames	String representing the range parameters.

◆ SelectMenuById()

static proto void DiagMenu.SelectMenuById ( int id )

static

Selects a menu by its id.

Parameters

id	Menu identifier.

◆ SelectMenuByName()

static proto void DiagMenu.SelectMenuByName ( string name )

static

Selects a menu by its name.

Parameters

name	Menu name.

◆ SetEngineRangeValue()

static proto void DiagMenu.SetEngineRangeValue	(	int	id,
		float	value )

static

Sets an engine float value for a range item.

Parameters

id	Identifier.
value	Value to set.

◆ SetEngineValue()

static proto void DiagMenu.SetEngineValue	(	int	id,
		int	value )

static

Sets an engine value directly.

Warning: Only for debugging.

Parameters

id	Identifier.
value	Value to set.

◆ SetRangeValue()

static proto void DiagMenu.SetRangeValue	(	int	id,
		float	value )

static

Sets the floating-point value for a range item.

Parameters

id	Range item identifier.
value	Value to set.

◆ SetValue()

static proto void DiagMenu.SetValue	(	int	id,
		int	value )

static

Sets an integer value for an item.

Parameters

id	Item identifier.
value	Value to set.

◆ Unregister()

static proto void DiagMenu.Unregister ( int id )

static

Unregisters a menu or item by id.

Parameters

id	Identifier of the element to unregister.

The documentation for this interface was generated from the following file:

Core/generated/Debug/DiagMenu.c

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBool()

◆ GetEngineRangeValue()

◆ GetEngineValue()

◆ GetRangeValue()

◆ GetValue()

◆ RegisterBool()

◆ RegisterItem()

◆ RegisterMenu()

◆ RegisterRange()

◆ SelectMenuById()

◆ SelectMenuByName()

◆ SetEngineRangeValue()

◆ SetEngineValue()

◆ SetRangeValue()

◆ SetValue()

◆ Unregister()