Класс UIManager

Закрытые члены
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)

Подробное описание

Методы

Back()

bool Back ( )

inlineprivate

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

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

Перекрестные ссылки GetMenu() и IsDialogVisible().

CloseAll()

bool CloseAll ( )

inlineprivate

Close all opened menus.

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

Перекрестные ссылки GetMenu().

Используется в MissionBase::CloseAllMenus(), MissionBase::DestroyAllMenus() и ActionUnfoldMapCB::PerformMapChange().

CloseAllSubmenus()

bool CloseAllSubmenus ( )

inlineprivate

Close all opened menus except first menu.

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

Перекрестные ссылки GetMenu().

CloseDialog()

proto native void CloseDialog ( )

private

CloseMenu()

bool CloseMenu ( int id )

inlineprivate

Close menu with specific ID (see MenuID)

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

Перекрестные ссылки GetMenu().

Используется в MissionBase::Continue().

CloseSpecificDialog()

proto native void CloseSpecificDialog ( int id )

private

CloseWindow()

void CloseWindow ( int id )

inlineprivate

    {
        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 );*/
            
        }
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, DeleteWindow(), GetGame(), UIScriptedWindow::GetWindow() и UIScriptedWindow::RemoveFromActiveWindows().

Используется в OpenWindow().

CreateScriptedMenu()

proto native UIScriptedMenu CreateScriptedMenu ( int id, UIMenuPanel parent )

private

DeleteWindow()

void DeleteWindow ( UIScriptedWindow window )

inlineprivate

    {
        delete window;
    }

Используется в CloseWindow().

EnterScriptedMenu()

proto native UIScriptedMenu EnterScriptedMenu ( int id, UIMenuPanel parent )

private

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

Используется в MissionBase::Pause(), ActionUnfoldMapCB::PerformMapChange() и 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)

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

Перекрестные ссылки GetMenu().

Используется в IsMenuOpen() и MissionBase::OnUpdate().

GetLoginQueuePosition()

proto native int GetLoginQueuePosition ( )

private

GetMenu()

proto native UIScriptedMenu GetMenu ( )

private

Returns most-top open menu.

Используется в Back(), CloseAll(), CloseAllSubmenus(), CloseMenu(), FindMenu(), HideMenu(), MissionBase::OnUpdate() и MissionBase::ShowInventory().

GetWidgetUnderCursor()

proto native Widget GetWidgetUnderCursor ( )

private

HideDialog()

proto native void HideDialog ( )

private

Используется в MissionBase::DestroyAllMenus() и MissionBase::OnMissionFinish().

HideMenu()

bool HideMenu ( int id )

inlineprivate

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

Перекрестные ссылки GetMenu() и HideScriptedMenu().

HideScriptedMenu()

proto native void HideScriptedMenu ( UIScriptedMenu menu )

private

Используется в MissionBase::HideInventory() и 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

Используется в Back() и MissionBase::OnUpdate().

IsMenuOpen()

bool IsMenuOpen ( int id )

inlineprivate

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

    {
        return FindMenu(id) != null;
    }

Перекрестные ссылки FindMenu().

IsModalVisible()

proto native bool IsModalVisible ( )

private

IsScaledMode()

proto native bool IsScaledMode ( )

private

IsWindowOpened()

bool IsWindowOpened ( int id )

inlineprivate

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

Перекрестные ссылки UIScriptedWindow::GetWindow().

OpenWindow()

void OpenWindow ( int id )

inlineprivate

    {
        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 );
        }
    }

Перекрестные ссылки UIScriptedWindow::AddToActiveWindows(), CloseWindow(), GetGame(), UIScriptedWindow::GetWindow() и GUI_WINDOW_MISSION_LOADER.

ScreenFadeIn()

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

private

ScreenFadeOut()

proto native void ScreenFadeOut ( float duration )

private

Используется в 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

ShowDialog()

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

private

Shows message dialog.

Аргументы

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

private

ShowScriptedMenu()

proto native UIScriptedMenu ShowScriptedMenu ( UIScriptedMenu menu, UIMenuPanel parent )

private

Используется в MissionBase::ShowInventory().

ShowUICursor()

void ShowUICursor ( bool visible )

inlineprivate

    {
        g_Game.SetMouseCursorDesiredVisibility(visible);
    }

Перекрестные ссылки g_Game.

Используется в MissionBase::OnMissionStart() и MissionBase::OnUpdate().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/tools/UIManager.c