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	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)

Detailed Description

Definition at line 1 of file UIManager.c.

Member Function Documentation

Back()

bool UIManager::Back ( )

inlineprivate

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

Definition at line 60 of file UIManager.c.

  {
    if (IsDialogVisible() == false)
    {
      UIMenuPanel menu = GetMenu();
      if (menu)
      {
        menu.Close();
        return true;
      }
    }
 
    return false;
  }

References GetMenu(), and IsDialogVisible().

CloseAll()

bool UIManager::CloseAll ( )

inlineprivate

Close all opened menus.

Definition at line 76 of file UIManager.c.

  {
    UIMenuPanel menu = GetMenu();
    while (menu)
    {
      if (menu.GetParentMenu())
        menu = menu.GetParentMenu();
      else
      {
        menu.Close();
        return true;
      }
    }
 
    return false;
  }

References GetMenu().

Referenced by MissionBase::CloseAllMenus(), MissionBase::DestroyAllMenus(), and ActionUnfoldMapCB::PerformMapChange().

CloseAllSubmenus()

bool UIManager::CloseAllSubmenus ( )

inlineprivate

Close all opened menus except first menu.

Definition at line 94 of file UIManager.c.

  {
    UIMenuPanel menu = GetMenu();
 
    while (menu && menu.GetParentMenu() && menu.GetParentMenu().GetParentMenu())
      menu = menu.GetParentMenu();
 
    if (menu && menu.GetParentMenu())
    {
      menu.Close();
      return true;
    }
 
    return false;
  }

References GetMenu().

CloseDialog()

proto native void UIManager::CloseDialog ( )

private

CloseMenu()

bool UIManager::CloseMenu ( int id )

inlineprivate

Close menu with specific ID (see MenuID)

Definition at line 111 of file UIManager.c.

  {
    UIMenuPanel menu = GetMenu();
 
    while (menu)
    {
      if (menu.GetID() == id)
      {
        menu.Close();
        return true;
      }
 
      menu = menu.GetParentMenu();
    }
 
    return false;
  }

References GetMenu().

Referenced by MissionBase::Continue().

CloseSpecificDialog()

proto native void UIManager::CloseSpecificDialog ( int id )

private

CloseWindow()

void UIManager::CloseWindow ( int id )

inlineprivate

Definition at line 201 of file UIManager.c.

  {
    UIScriptedWindow window = UIScriptedWindow.GetWindow(id);
 
    if (window)
    {
      UIScriptedWindow.RemoveFromActiveWindows(id);
      window.HideWindow();
 
      //delete window;
      GetGame().GetCallQueue(CALL_CATEGORY_SYSTEM).Call(this.DeleteWindow, window);
      /*
        wtf? leak
        Timer delete_timer = new Timer ( CALL_CATEGORY_SYSTEM );
        Param1<UIScriptedWindow> params = new Param1<UIScriptedWindow>( window );
        delete_timer.Run( 0.5, this, "DeleteWindow", params, false );*/
 
    }
  }

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

Referenced by OpenWindow().

CreateScriptedMenu()

proto native UIScriptedMenu UIManager::CreateScriptedMenu ( int id, UIMenuPanel parent )

private

DeleteWindow()

void UIManager::DeleteWindow ( UIScriptedWindow window )

inlineprivate

Definition at line 221 of file UIManager.c.

  {
    delete window;
  }

Referenced by CloseWindow().

EnterScriptedMenu()

proto native UIScriptedMenu UIManager::EnterScriptedMenu ( int id, UIMenuPanel parent )

private

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

Referenced by MissionBase::Pause(), ActionUnfoldMapCB::PerformMapChange(), and MissionBase::ShowChat().

EnterServerBrowser()

proto native void UIManager::EnterServerBrowser ( UIMenuPanel parentMenu )

private

FindMenu()

UIScriptedMenu UIManager::FindMenu ( int id )

inlineprivate

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

Definition at line 154 of file UIManager.c.

  {
    UIScriptedMenu menu = GetMenu();
 
    while (menu)
    {
      if (menu.GetID() == id)
        return menu;
 
      menu = UIScriptedMenu.Cast(menu.GetParentMenu());
    }
 
    return NULL;
  }

References GetMenu().

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

GetLoginQueuePosition()

proto native int UIManager::GetLoginQueuePosition ( )

private

GetMenu()

proto native UIScriptedMenu UIManager::GetMenu ( )

private

Returns most-top open menu.

Referenced by Back(), CloseAll(), CloseAllSubmenus(), CloseMenu(), FindMenu(), HideMenu(), MissionBase::OnUpdate(), and MissionBase::ShowInventory().

GetWidgetUnderCursor()

proto native Widget UIManager::GetWidgetUnderCursor ( )

private

HideDialog()

proto native void UIManager::HideDialog ( )

private

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

HideMenu()

bool UIManager::HideMenu ( int id )

inlineprivate

Definition at line 129 of file UIManager.c.

  {
    UIScriptedMenu menu = GetMenu();
 
    while (menu)
    {
      if (menu.GetID() == id)
      {
        HideScriptedMenu(menu);
        return true;
      }
 
      menu = UIScriptedMenu.Cast(menu.GetParentMenu());
    }
 
    return false;
  }

References GetMenu(), and HideScriptedMenu().

HideScriptedMenu()

proto native void UIManager::HideScriptedMenu ( UIScriptedMenu menu )

private

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

IsCursorVisible()

proto native bool UIManager::IsCursorVisible ( )

private

IsDialogQueued()

proto native bool UIManager::IsDialogQueued ( )

private

IsDialogVisible()

proto native bool UIManager::IsDialogVisible ( )

private

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

IsMenuOpen()

bool UIManager::IsMenuOpen ( int id )

inlineprivate

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

Definition at line 148 of file UIManager.c.

  {
    return FindMenu(id) != null;
  }

References FindMenu().

IsModalVisible()

proto native bool UIManager::IsModalVisible ( )

private

IsScaledMode()

proto native bool UIManager::IsScaledMode ( )

private

IsWindowOpened()

bool UIManager::IsWindowOpened ( int id )

inlineprivate

Definition at line 226 of file UIManager.c.

  {
    if (UIScriptedWindow.GetWindow(id))
      return true;
 
    return false;
  }

References UIScriptedWindow::GetWindow().

OpenWindow()

void UIManager::OpenWindow ( int id )

inlineprivate

Definition at line 170 of file UIManager.c.

  {
    UIScriptedWindow window = UIScriptedWindow.GetWindow(id);
 
    //if window is already opened, close it
    if (window)
    {
      CloseWindow(id);
 
      return;
    }
 
    //create new window
    switch (id)
    {
    case GUI_WINDOW_MISSION_LOADER:
      window = GetGame().GetMission().CreateScriptedWindow(id);
      break;
 
    default: {};
    }
 
    if (window)
    {
      window.Init();
 
      //add to active windows
      UIScriptedWindow.AddToActiveWindows(id, window);
    }
  }

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

ScreenFadeIn()

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

private

ScreenFadeOut()

proto native void UIManager::ScreenFadeOut ( float duration )

private

Referenced by MissionBase::OnUpdate().

ScreenFadeVisible()

proto native bool UIManager::ScreenFadeVisible ( )

private

SetScaledMode()

proto native void UIManager::SetScaledMode ( bool enabled )

private

ShowCursor()

proto native bool UIManager::ShowCursor ( bool visible )

private

natively checks game focus on cursor hiding

ShowDialog()

proto native void UIManager::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; GetGame().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 UIManager::ShowQueuedDialog ( )

private

ShowScriptedMenu()

proto native UIScriptedMenu UIManager::ShowScriptedMenu ( UIScriptedMenu menu, UIMenuPanel parent )

private

Referenced by MissionBase::ShowInventory().

ShowUICursor()

void UIManager::ShowUICursor ( bool visible )

inlineprivate

Definition at line 234 of file UIManager.c.

  {
    g_Game.SetMouseCursorDesiredVisibility(visible);
  }

References g_Game.

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

---

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

• scripts/3_Game/tools/UIManager.c