SCR_JoinRequestEntry Interface Reference

Inheritance diagram for SCR_JoinRequestEntry:

Public Member Functions
void	SetParentMenu (SCR_RequestToJoinSubmenu menu)
void	SetPlayerID (int value)
int	GetPlayerID ()
override void	OnMenuFocusGained ()
override void	OnMenuFocusLost ()
void	Init (Widget w)
	Method triggered manually after widget creation process was finished.
override void	HandlerAttached (Widget w)
	Initialization of the component, after it was attached to the widet.
Public Member Functions inherited from SCR_SubMenuBase
void	OnMenuShow ()
void	OnMenuHide ()
void	OnMenuUpdate (float tDelta)
void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
void	OnTabShow ()
void	OnTabHide ()
void	OnTabRemove ()
void	OnTabChange ()
bool	GetShown ()
int	GetIndex ()
ScriptInvokerVoid	GetOnRequestCloseMenu ()
ScriptInvokerInt2	GetOnRequestTabChange ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	AcceptToJoinPrivateGroup ()
	Callback method used to accept the reqeust.
void	RefuseJoinPrivateGroup ()
	Callback method used to reject the reqeust.
Protected Member Functions inherited from SCR_SubMenuBase
void	ShowNavigationButtons (bool show)
void	FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show)
void	SetNavigationButtonVisible (SCR_InputButtonComponent button, bool show, bool animate=false)
SCR_InputButtonComponent	CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true)
void	RequestCloseMenu ()
void	RequestTabChange (int newTabIndex)

Protected Attributes
int	m_iPlayerID
SCR_RequestToJoinSubmenu	m_ParentMenu
SCR_InputButtonComponent	m_RefuseButton
SCR_InputButtonComponent	m_AcceptButton
Protected Attributes inherited from SCR_SubMenuBase
ResourceName	m_sNavigationButtonLayout
SCR_DynamicFooterComponent	m_DynamicFooter
ref array< SCR_InputButtonComponent >	m_aNavigationButtons = {}
ref map< SCR_InputButtonComponent, bool >	m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()
Widget	m_wMenuRoot
int	m_iIndex
bool	m_bShown
bool	m_bFocused
ref ScriptInvokerVoid	m_OnRequestCloseMenu
ref ScriptInvokerInt2	m_OnRequestTabChange
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

AcceptToJoinPrivateGroup()

void SCR_JoinRequestEntry.AcceptToJoinPrivateGroup ( )

protected

Callback method used to accept the reqeust.

GetPlayerID()

int SCR_JoinRequestEntry.GetPlayerID

(

)

Returns

HandlerAttached()

override void SCR_JoinRequestEntry.HandlerAttached

(

Widget

w

)

Initialization of the component, after it was attached to the widet.

Note: at this point other components on this widget may not exist yet, and for interacting with them use Init(w)

Parameters

[in]

w

widget to which this handler was attached

Implements SCR_ScriptedWidgetComponent.

Init()

void SCR_JoinRequestEntry.Init

(

Widget

w

)

Method triggered manually after widget creation process was finished.

Parameters

[in]

w

widget on which this handler is initalized

OnMenuFocusGained()

override void SCR_JoinRequestEntry.OnMenuFocusGained

(

)

Implements SCR_SubMenuBase.

OnMenuFocusLost()

override void SCR_JoinRequestEntry.OnMenuFocusLost

(

)

Implements SCR_SubMenuBase.

RefuseJoinPrivateGroup()

void SCR_JoinRequestEntry.RefuseJoinPrivateGroup ( )

protected

Callback method used to reject the reqeust.

SetParentMenu()

void SCR_JoinRequestEntry.SetParentMenu

(

SCR_RequestToJoinSubmenu

menu

)

Parameters

[in]

menu

SetPlayerID()

void SCR_JoinRequestEntry.SetPlayerID

(

int

value

)

Parameters

[in]

value

Member Data Documentation

m_AcceptButton

SCR_InputButtonComponent SCR_JoinRequestEntry.m_AcceptButton

protected

m_iPlayerID

int SCR_JoinRequestEntry.m_iPlayerID

protected

m_ParentMenu

SCR_RequestToJoinSubmenu SCR_JoinRequestEntry.m_ParentMenu

protected

m_RefuseButton

SCR_InputButtonComponent SCR_JoinRequestEntry.m_RefuseButton

protected

---

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

• Game/Groups/SCR_JoinRequestEntry.c