UIMenuPanel Class Reference

Part of main menu hierarchy to create custom menus from script. More...

Private Member Functions
proto native UIMenuPanel	GetSubMenu ()
proto native UIMenuPanel	GetParentMenu ()
proto native UIMenuPanel	GetVisibleMenu ()
proto native void	SetSubMenu (UIMenuPanel submenu)
proto native void	SetParentMenu (UIMenuPanel parent)
proto native bool	CanClose ()
proto native bool	CanCloseOnEscape ()
proto native UIScriptedMenu	EnterScriptedMenu (int id)
	Create & open menu with specific id (see MenuID) and set this menu as its parent.
proto native void	DestroySubmenu ()
proto native bool	IsAnyMenuVisible ()
proto native bool	IsVisible ()
void	OnVisibilityChanged (bool isVisible)
proto native void	Close ()
	Safe way to close window, using this function can even window safely close itself.
bool	UseMouse ()
bool	UseKeyboard ()
bool	UseGamepad ()
int	GetID ()
	Returns MenuID.
void	Refresh ()
	Refresh request, called from anywhere.
Widget	GetLayoutRoot ()
void	LockControls ()
void	UnlockControls ()
void	UIScriptedMenu ()
void	~UIScriptedMenu ()
void	SetID (int id)
	Sets MenuID.
override int	GetID ()
	Returns MenuID.
void	SetWidgetAnimAlpha (Widget widget)
Widget	Init ()
void	Cleanup ()
void	OnShow ()
void	OnHide ()
void	Update (float timeslice)
	Per frame update, called from engine.
proto native void	SetFadingPanels (Widget panel0, Widget panel1, Widget panel2, Widget panel3, Widget panel4)
	Refresh request, called from anywhere.
bool	OnClick (Widget w, int x, int y, int button)
bool	OnModalResult (Widget w, int x, int y, int code, int result)
bool	OnDoubleClick (Widget w, int x, int y, int button)
bool	OnSelect (Widget w, int x, int y)
bool	OnItemSelected (Widget w, int x, int y, int row, int column, int oldRow, int oldColumn)
bool	OnFocus (Widget w, int x, int y)
bool	OnFocusLost (Widget w, int x, int y)
bool	OnMouseEnter (Widget w, int x, int y)
bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
bool	OnMouseButtonDown (Widget w, int x, int y, int button)
bool	OnMouseButtonUp (Widget w, int x, int y, int button)
bool	OnMouseWheel (Widget w, int x, int y, int wheel)
bool	OnController (Widget w, int control, int value)
bool	OnKeyDown (Widget w, int x, int y, int key)
bool	OnKeyUp (Widget w, int x, int y, int key)
bool	OnKeyPress (Widget w, int x, int y, int key)
bool	OnChange (Widget w, int x, int y, bool finished)
bool	OnDrag (Widget w, int x, int y)
bool	OnDragging (Widget w, int x, int y, Widget reciever)
bool	OnDraggingOver (Widget w, int x, int y, Widget reciever)
bool	OnDrop (Widget w, int x, int y, Widget reciever)
bool	OnDropReceived (Widget w, int x, int y, Widget reciever)
bool	OnEvent (EventType eventType, Widget target, int parameter0, int parameter1)
ScriptedWidgetEventHandler	GetContextMenu ()
bool	OnXboxEvent (int xboxEvent)
void	OnRPC (ParamsReadContext ctx)
void	OnRPCEx (int rpc_type, ParamsReadContext ctx)
void	InitNoteWrite (EntityAI paper, EntityAI pen, string text="")
void	InitNoteRead (string text="")
void	InitMapItem (EntityAI item)
void	LoadMapMarkers ()
bool	IsHandlingPlayerDeathEvent ()
void	OnPlayerDeath ()

Private Attributes
int	m_id
Widget	layoutRoot
private Widget	m_AnimAlphaWidget
private bool	m_AnimAlphaIsIncreasing
private float	m_AnimAlphaValue
private ScriptInvoker	m_PlayerDeathInvoker

Detailed Description

Part of main menu hierarchy to create custom menus from script.

Constructor & Destructor Documentation

~UIScriptedMenu()

void ~UIScriptedMenu ( )

inlineprivate

Member Function Documentation

CanClose()

proto native bool CanClose ( )

private

CanCloseOnEscape()

proto native bool CanCloseOnEscape ( )

private

Cleanup()

void Cleanup ( )

inlineprivate

Close()

proto native void Close ( )

private

Safe way to close window, using this function can even window safely close itself.

Referenced by UIManager::Back(), UIManager::CloseAll(), UIManager::CloseAllSubmenus(), and UIManager::CloseMenu().

DestroySubmenu()

proto native void DestroySubmenu ( )

private

EnterScriptedMenu()

proto native UIScriptedMenu EnterScriptedMenu ( int  id )

private

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

Referenced by MissionBase::CreateLogoutMenu().

GetContextMenu()

ScriptedWidgetEventHandler GetContextMenu ( )

inlineprivate

GetID() [1/2]

int GetID ( )

inlineprivate

Returns MenuID.

References MENU_UNKNOWN.

Referenced by UIManager::CloseMenu().

GetID() [2/2]

override int GetID ( )

inlineprivate

Returns MenuID.

GetLayoutRoot()

Widget GetLayoutRoot ( )

inlineprivate

GetParentMenu()

proto native UIMenuPanel GetParentMenu ( )

private

Referenced by UIManager::CloseAll(), UIManager::CloseAllSubmenus(), and UIManager::CloseMenu().

GetSubMenu()

proto native UIMenuPanel GetSubMenu ( )

private

GetVisibleMenu()

proto native UIMenuPanel GetVisibleMenu ( )

private

Init()

Widget Init ( )

inlineprivate

InitMapItem()

void InitMapItem ( EntityAI  item )

inlineprivate

InitNoteRead()

void InitNoteRead ( string  text = "" )

inlineprivate

InitNoteWrite()

void InitNoteWrite ( EntityAI  paper, EntityAI  pen, string  text = ""  )

inlineprivate

IsAnyMenuVisible()

proto native bool IsAnyMenuVisible ( )

private

IsHandlingPlayerDeathEvent()

bool IsHandlingPlayerDeathEvent ( )

inlineprivate

IsVisible()

proto native bool IsVisible ( )

private

LoadMapMarkers()

void LoadMapMarkers ( )

inlineprivate

LockControls()

void LockControls ( )

inlineprivate

References Input::ChangeGameFocus(), GetGame(), CGame::GetInput(), CGame::GetUIManager(), INPUT_DEVICE_GAMEPAD, INPUT_DEVICE_KEYBOARD, INPUT_DEVICE_MOUSE, UIManager::ShowUICursor(), UIScriptedMenu::UseGamepad(), UIScriptedMenu::UseKeyboard(), and UIScriptedMenu::UseMouse().

OnChange()

bool OnChange ( Widget  w, int  x, int  y, bool  finished  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnClick()

bool OnClick ( Widget  w, int  x, int  y, int  button  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnController()

bool OnController ( Widget  w, int  control, int  value  )

inlineprivate

References Count, and UIScriptedWindow::GetActiveWindows().

OnDoubleClick()

bool OnDoubleClick ( Widget  w, int  x, int  y, int  button  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnDrag()

bool OnDrag ( Widget  w, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnDragging()

bool OnDragging ( Widget  w, int  x, int  y, Widget  reciever  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnDraggingOver()

bool OnDraggingOver ( Widget  w, int  x, int  y, Widget  reciever  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnDrop()

bool OnDrop ( Widget  w, int  x, int  y, Widget  reciever  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnDropReceived()

bool OnDropReceived ( Widget  w, int  x, int  y, Widget  reciever  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnEvent()

bool OnEvent ( EventType  eventType, Widget  target, int  parameter0, int  parameter1  )

inlineprivate

References Count, and UIScriptedWindow::GetActiveWindows().

OnFocus()

bool OnFocus ( Widget  w, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnFocusLost()

bool OnFocusLost ( Widget  w, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnHide()

void OnHide ( )

inlineprivate

References UIScriptedMenu::OnPlayerDeath(), and ScriptInvoker::Remove().

OnItemSelected()

bool OnItemSelected ( Widget  w, int  x, int  y, int  row, int  column, int  oldRow, int  oldColumn  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnKeyDown()

bool OnKeyDown ( Widget  w, int  x, int  y, int  key  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnKeyPress()

bool OnKeyPress ( Widget  w, int  x, int  y, int  key  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnKeyUp()

bool OnKeyUp ( Widget  w, int  x, int  y, int  key  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnModalResult()

bool OnModalResult ( Widget  w, int  x, int  y, int  code, int  result  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnMouseButtonDown()

bool OnMouseButtonDown ( Widget  w, int  x, int  y, int  button  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnMouseButtonUp()

bool OnMouseButtonUp ( Widget  w, int  x, int  y, int  button  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnMouseEnter()

bool OnMouseEnter ( Widget  w, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnMouseLeave()

bool OnMouseLeave ( Widget  w, Widget  enterW, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnMouseWheel()

bool OnMouseWheel ( Widget  w, int  x, int  y, int  wheel  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnPlayerDeath()

void OnPlayerDeath ( )

inlineprivate

References Close().

OnRPC()

void OnRPC ( ParamsReadContext  ctx )

inlineprivate

OnRPCEx()

void OnRPCEx ( int  rpc_type, ParamsReadContext  ctx  )

inlineprivate

OnSelect()

bool OnSelect ( Widget  w, int  x, int  y  )

inlineprivate

References Count, UIScriptedWindow::GetActiveWindows(), x, and y.

OnShow()

void OnShow ( )

inlineprivate

References g_Game, ScriptInvoker::Insert(), UIScriptedMenu::IsHandlingPlayerDeathEvent(), and UIScriptedMenu::OnPlayerDeath().

OnVisibilityChanged()

void OnVisibilityChanged ( bool  isVisible )

inlineprivate

If visibility of application is changed. On console it is called when application is suspended or constrained.

Parameters

isVisible

indicate if application is visible in foreground

OnXboxEvent()

bool OnXboxEvent ( int  xboxEvent )

inlineprivate

Refresh()

void Refresh ( )

inlineprivate

Refresh request, called from anywhere.

SetFadingPanels()

proto native void SetFadingPanels ( Widget  panel0, Widget  panel1, Widget  panel2, Widget  panel3, Widget  panel4  )

private

Refresh request, called from anywhere.

SetID()

void SetID ( int  id )

inlineprivate

Sets MenuID.

SetParentMenu()

proto native void SetParentMenu ( UIMenuPanel  parent )

private

SetSubMenu()

proto native void SetSubMenu ( UIMenuPanel  submenu )

private

SetWidgetAnimAlpha()

void SetWidgetAnimAlpha ( Widget  widget )

inlineprivate

UIScriptedMenu()

void UIScriptedMenu ( )

inlineprivate

References MENU_UNKNOWN.

UnlockControls()

void UnlockControls ( )

inlineprivate

References Input::ChangeGameFocus(), GetGame(), CGame::GetInput(), CGame::GetUIManager(), INPUT_DEVICE_GAMEPAD, INPUT_DEVICE_KEYBOARD, INPUT_DEVICE_MOUSE, UIManager::ShowUICursor(), UIScriptedMenu::UseGamepad(), UIScriptedMenu::UseKeyboard(), and UIScriptedMenu::UseMouse().

Update()

void Update ( float  timeslice )

inlineprivate

Per frame update, called from engine.

UseGamepad()

bool UseGamepad ( )

inlineprivate

UseKeyboard()

bool UseKeyboard ( )

inlineprivate

References GetGame(), CGame::GetInput(), and Input::IsEnabledMouseAndKeyboardEvenOnServer().

UseMouse()

bool UseMouse ( )

inlineprivate

References GetGame(), CGame::GetInput(), and Input::IsEnabledMouseAndKeyboardEvenOnServer().

Field Documentation

layoutRoot

Widget layoutRoot

private

m_AnimAlphaIsIncreasing

private bool m_AnimAlphaIsIncreasing

private

m_AnimAlphaValue

private float m_AnimAlphaValue

private

m_AnimAlphaWidget

private Widget m_AnimAlphaWidget

private

m_id

int m_id

private

m_PlayerDeathInvoker

private ScriptInvoker m_PlayerDeathInvoker

private

---

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

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