SCR_PlayerHubWarningEditorUIComponent Interface Reference

Inheritance diagram for SCR_PlayerHubWarningEditorUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Static Public Member Functions
static void	SetWarningTimer (int newTimer, SCR_PlayerHubAreaTriggerEntity newHub, IEntity playerInTrigger)
static void	CancelWarningTimer (SCR_PlayerHubAreaTriggerEntity hub, bool hubDestroyed=false)

Protected Member Functions
void	UpdateTimer ()
void	TimerDone (bool canceled=false)
void	ShowTimer ()
void	HideTimer ()
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
Widget	m_WidgetRef
bool	m_bTimerSet
int	m_iCurrentWarningTimer
SCR_PlayerHubAreaTriggerEntity	m_LinkedHub
string	m_sTimerText
TextWidget	m_TimerText
IEntity	m_PlayerRef
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
static SCR_PlayerHubWarningEditorUIComponent	m_Self

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500

Member Function Documentation

CancelWarningTimer()

static void SCR_PlayerHubWarningEditorUIComponent.CancelWarningTimer ( SCR_PlayerHubAreaTriggerEntity  hub, bool  hubDestroyed = false  )

static

Parameters

[in]	hub
[in]	hubDestroyed

HandlerAttached()

override void SCR_PlayerHubWarningEditorUIComponent.HandlerAttached

(

Widget

w

)

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_PlayerHubWarningEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

HideTimer()

void SCR_PlayerHubWarningEditorUIComponent.HideTimer ( )

protected

SetWarningTimer()

static void SCR_PlayerHubWarningEditorUIComponent.SetWarningTimer ( int  newTimer, SCR_PlayerHubAreaTriggerEntity  newHub, IEntity  playerInTrigger  )

static

Parameters

[in]	newTimer
[in]	newHub
[in]	playerInTrigger

ShowTimer()

void SCR_PlayerHubWarningEditorUIComponent.ShowTimer ( )

protected

TimerDone()

void SCR_PlayerHubWarningEditorUIComponent.TimerDone ( bool  canceled = false )

protected

UpdateTimer()

void SCR_PlayerHubWarningEditorUIComponent.UpdateTimer ( )

protected

Member Data Documentation

m_bTimerSet

bool SCR_PlayerHubWarningEditorUIComponent.m_bTimerSet

protected

m_iCurrentWarningTimer

int SCR_PlayerHubWarningEditorUIComponent.m_iCurrentWarningTimer

protected

m_LinkedHub

SCR_PlayerHubAreaTriggerEntity SCR_PlayerHubWarningEditorUIComponent.m_LinkedHub

protected

m_PlayerRef

IEntity SCR_PlayerHubWarningEditorUIComponent.m_PlayerRef

protected

m_Self

SCR_PlayerHubWarningEditorUIComponent SCR_PlayerHubWarningEditorUIComponent.m_Self

staticprotected

m_sTimerText

string SCR_PlayerHubWarningEditorUIComponent.m_sTimerText

protected

m_TimerText

TextWidget SCR_PlayerHubWarningEditorUIComponent.m_TimerText

protected

m_WidgetRef

Widget SCR_PlayerHubWarningEditorUIComponent.m_WidgetRef

protected

---

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

• Game/Editor/UI/Components/Common/SCR_PlayerHubWarningEditorUIComponent.c