Configuration class for BaseModeInstance. More...

Public Attributes
ExternalWindow *	Window
	The external window this mode belongs to. More...

bool	IgnoreWindow
	Ignore window input requirement - If true, ProcessKeys and ProcessMouse will always be queried regardless of whether this mode's window has focus or not.

bool	AllowKeyControl
	Allow keyboard control – If false, then BaseModeInstance::ProcessKeys is not called.

bool	AllowMouseControl
	Allow mouse control – If false, then BaseModeInstance::ProcessMouse is not called.

bool	ProcessMouseOnMove
	Only process mouse on movement – If true, then BaseModeInstance::ProcessMouse will only be called when the mouse is moved, rather than every frame.

int	AltF4RetValue
	The return code that pressing Alt+F4 should provide.

unsigned int	CustomMagnification
	The return code that pressing Alt+F4 should provide.

struct {
bool Enabled
	If menu controls are actually enabled.

MENU_CONTROLS_DRAW_POSITION DrawPosition
	The draw position for menu controls.

bool AllowAutoHide
	Automatically hide the menu controls after a while.

bool OpenOnTab
	Open when 'TAB' is pressed.

bool OpenOnHover
	Open when hovered over.

int ClosedAlpha
	The alpha value when the menu controls are closed (0 - 255)

int OpenedAlpha
	The alpha value when the menu controls are opened (0 - 255)

int FrameTime
	The amount of time it takes to open the menu controls.

int HideTime
	The amount of time it takes to close the menu controls.

}	MenuControls
	Menu controls configuration.

Detailed Description

Configuration class for BaseModeInstance.

Member Data Documentation

ExternalWindow* BaseModeInstance::ModeConfiguration::Window

The external window this mode belongs to.

This will be queried with 'ExternalWindow::TestWindowInputFocus' and 'ExternalWindow::TestWindowMouseFocus' to determine whether ProcessMouse and ProcessKeys is able to be called.

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