UIManager Class Reference

Private Member Functions
proto native UIScriptedMenu	EnterScriptedMenu (int id, UIMenuPanel parent)
	Create & open menu with specific id (see MenuID) and set its parent.
proto native UIScriptedMenu	CreateScriptedMenu (int id, UIMenuPanel parent)
proto native void	EnterServerBrowser (UIMenuPanel parentMenu)
proto native UIScriptedMenu	ShowScriptedMenu (UIScriptedMenu menu, UIMenuPanel parent)
proto native void	HideScriptedMenu (UIScriptedMenu menu)
proto native Widget	GetWidgetUnderCursor ()
proto native bool	IsDialogVisible ()
proto native bool	IsDialogHiding ()
	Returns true for a single frame whenever a dialog is hidden.
proto native bool	IsModalVisible ()
proto native void	CloseSpecificDialog (int id)
proto native void	CloseDialog ()
proto native void	HideDialog ()
proto native void	ShowDialog (string caption, string text, int id, int butts, int def, int type, UIScriptedMenu handler)
	Shows message dialog.
proto native bool	ShowCursor (bool visible)
	natively checks game focus on cursor hiding
proto native bool	IsCursorVisible ()
proto native bool	IsDialogQueued ()
proto native bool	ShowQueuedDialog ()
proto native int	GetLoginQueuePosition ()
proto native bool	ScreenFadeVisible ()
proto native void	ScreenFadeIn (float duration, string text, int backgroundColor, int textColor)
proto native void	ScreenFadeOut (float duration)
proto native bool	IsScaledMode ()
proto native void	SetScaledMode (bool enabled)
proto native UIScriptedMenu	GetMenu ()
	Returns most-top open menu.
bool	Back ()
	Close top window on windows stack, returns true when any window is closed.
bool	CloseAll ()
	Close all opened menus.
bool	CloseAllSubmenus ()
	Close all opened menus except first menu.
bool	CloseMenu (int id)
	Close menu with specific ID (see MenuID)
bool	HideMenu (int id)
bool	IsMenuOpen (int id)
	Returns true if menu with specific ID is opened (see MenuID)
UIScriptedMenu	FindMenu (int id)
	Returns menu with specific ID if it is open (see MenuID)
void	OpenWindow (int id)
void	CloseWindow (int id)
void	DeleteWindow (UIScriptedWindow window)
bool	IsWindowOpened (int id)
void	ShowUICursor (bool visible)

Member Function Documentation

Back()

bool Back ( )

inlineprivate

Close top window on windows stack, returns true when any window is closed.

References UIMenuPanel::Close(), GetMenu(), and IsDialogVisible().

CloseAll()

bool CloseAll ( )

inlineprivate

Close all opened menus.

References UIMenuPanel::Close(), GetMenu(), and UIMenuPanel::GetParentMenu().

Referenced by MissionBase::CloseAllMenus(), MissionBase::DestroyAllMenus(), MissionBase::HandleMapToggleByKeyboardShortcut(), MissionBase::InputBufferCheck(), MissionBase::OnInputBufferEvent(), CGame::OnLoginTimeEvent(), CGame::OnRespawnEvent(), ActionUnfoldMapCB::PerformMapChange(), and CGame::UpdateLoginQueue().

CloseAllSubmenus()

bool CloseAllSubmenus ( )

inlineprivate

Close all opened menus except first menu.

References UIMenuPanel::Close(), GetMenu(), and UIMenuPanel::GetParentMenu().

CloseDialog()

proto native void CloseDialog ( )

private

Referenced by ManBase::OnUnconsciousStop().

CloseMenu()

bool CloseMenu ( int  id )

inlineprivate

Close menu with specific ID (see MenuID)

References UIMenuPanel::Close(), UIMenuPanel::GetID(), GetMenu(), and UIMenuPanel::GetParentMenu().

Referenced by MissionBase::Continue().

CloseSpecificDialog()

proto native void CloseSpecificDialog ( int  id )

private

CloseWindow()

void CloseWindow ( int  id )

inlineprivate

References CALL_CATEGORY_SYSTEM, DeleteWindow(), g_Game, UIScriptedWindow::GetWindow(), UIScriptedWindow::HideWindow(), and UIScriptedWindow::RemoveFromActiveWindows().

Referenced by OpenWindow().

CreateScriptedMenu()

proto native UIScriptedMenu CreateScriptedMenu ( int  id, UIMenuPanel  parent  )

private

DeleteWindow()

void DeleteWindow ( UIScriptedWindow  window )

inlineprivate

Referenced by CloseWindow().

EnterScriptedMenu()

proto native UIScriptedMenu EnterScriptedMenu ( int  id, UIMenuPanel  parent  )

private

Create & open menu with specific id (see MenuID) and set its parent.

Referenced by MissionBase::HandleMapToggleByKeyboardShortcut(), MissionBase::InputBufferCheck(), MissionBase::OnInputBufferEvent(), MissionBase::Pause(), ActionUnfoldMapCB::PerformMapChange(), CGame::SelectGamepad(), and MissionBase::ShowChat().

EnterServerBrowser()

proto native void EnterServerBrowser ( UIMenuPanel  parentMenu )

private

FindMenu()

UIScriptedMenu FindMenu ( int  id )

inlineprivate

Returns menu with specific ID if it is open (see MenuID)

References GetMenu().

Referenced by ManBase::CloseMapEx(), IsMenuOpen(), ManBase::OnRestrainChangeClient(), ManBase::OnRestrainStartedChangeClient(), ManBase::OnUnconsciousStop(), MissionBase::OnUpdate(), and Hud::RefreshQuickbar().

GetLoginQueuePosition()

proto native int GetLoginQueuePosition ( )

private

Referenced by CGame::UpdateLoginQueue().

GetMenu()

proto native UIScriptedMenu GetMenu ( )

private

Returns most-top open menu.

Referenced by Back(), CloseAll(), CloseAllSubmenus(), CloseMenu(), MissionBase::CreateLogoutMenu(), FindMenu(), HideMenu(), MissionBase::InputBufferCheck(), MissionBase::OnInputBufferEvent(), CGame::OnLoginTimeEvent(), CGame::OnRespawnEvent(), MissionBase::OnUpdate(), CGame::SelectGamepad(), CGame::SetDatabaseID(), MissionBase::ShowInventory(), and CGame::UpdateLoginQueue().

GetWidgetUnderCursor()

proto native Widget GetWidgetUnderCursor ( )

private

HideDialog()

proto native void HideDialog ( )

private

Referenced by MissionBase::DestroyAllMenus(), and MissionBase::OnMissionFinish().

HideMenu()

bool HideMenu ( int  id )

inlineprivate

References GetMenu(), and HideScriptedMenu().

HideScriptedMenu()

proto native void HideScriptedMenu ( UIScriptedMenu  menu )

private

Referenced by MissionBase::HideInventory(), and HideMenu().

IsCursorVisible()

proto native bool IsCursorVisible ( )

private

IsDialogHiding()

proto native bool IsDialogHiding ( )

private

Returns true for a single frame whenever a dialog is hidden.

IsDialogQueued()

proto native bool IsDialogQueued ( )

private

IsDialogVisible()

proto native bool IsDialogVisible ( )

private

Referenced by Back(), ManBase::OnUnconsciousStop(), and MissionBase::OnUpdate().

IsMenuOpen()

bool IsMenuOpen ( int  id )

inlineprivate

Returns true if menu with specific ID is opened (see MenuID)

References FindMenu().

Referenced by ManBase::CloseMapEx(), MissionBase::HandleMapToggleByKeyboardShortcut(), ManBase::OnRestrainChangeClient(), ManBase::OnRestrainStartedChangeClient(), and ManBase::OnUnconsciousStop().

IsModalVisible()

proto native bool IsModalVisible ( )

private

IsScaledMode()

proto native bool IsScaledMode ( )

private

IsWindowOpened()

bool IsWindowOpened ( int  id )

inlineprivate

References UIScriptedWindow::GetWindow().

OpenWindow()

void OpenWindow ( int  id )

inlineprivate

References UIScriptedWindow::AddToActiveWindows(), CloseWindow(), g_Game, UIScriptedWindow::GetWindow(), GUI_WINDOW_MISSION_LOADER, and UIScriptedWindow::Init().

ScreenFadeIn()

proto native void ScreenFadeIn ( float  duration, string  text, int  backgroundColor, int  textColor  )

private

ScreenFadeOut()

proto native void ScreenFadeOut ( float  duration )

private

Referenced by CGame::LoadProgressUpdate(), and MissionBase::OnUpdate().

ScreenFadeVisible()

proto native bool ScreenFadeVisible ( )

private

SetScaledMode()

proto native void SetScaledMode ( bool  enabled )

private

ShowCursor()

proto native bool ShowCursor ( bool  visible )

private

natively checks game focus on cursor hiding

Referenced by CGame::RefreshMouseCursorVisibility().

ShowDialog()

proto native void ShowDialog ( string  caption, string  text, int  id, int  butts, int  def, int  type, UIScriptedMenu  handler  )

private

Shows message dialog.

Parameters

caption
text
id	custom user id
butts	DialogBoxType
def	DialogBoxButton
type	DialogMessageType
handler	usage : const int QUIT_DIALOG_ID = 76; g_Game.GetUIManager().ShowDialog("Quit", "Do You really want to quit?", QUIT_DIALOG_ID, DBT_YESNO, DBB_YES, DMT_QUESTION, this); ... // after user pass dialog, callback on menu/event handler is called ScriptedWidgetEventHandler::OnModalResult( Widget w, int x, int y, int code, int result ) { if (code == QUIT_DIALOG_ID && result == DBB_YES) // yes this is callback for dialog we show earlier and user press YES button { Quit(); } }

ShowQueuedDialog()

proto native bool ShowQueuedDialog ( )

private

Referenced by CGame::CheckDialogs().

ShowScriptedMenu()

proto native UIScriptedMenu ShowScriptedMenu ( UIScriptedMenu  menu, UIMenuPanel  parent  )

private

Referenced by CGame::OnLoginTimeEvent(), MissionBase::ShowInventory(), and CGame::UpdateLoginQueue().

ShowUICursor()

void ShowUICursor ( bool  visible )

inlineprivate

References g_Game.

Referenced by MissionBase::OnMissionStart(), and MissionBase::OnUpdate().

---

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

• P:/scripts/3_Game/tools/UIManager.c