SCR_MenuActionsComponent Interface Reference

Inheritance diagram for SCR_MenuActionsComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	ActivateActions ()
void	DeactivateActions ()
array< ref SCR_MenuActionPreset >	GetActions ()
ScriptInvokerAction	GetOnAction ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static SCR_MenuActionsComponent	FindComponent (Widget w)
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.

Protected Member Functions
void	OnMenuDeactivated (ChimeraMenuBase menu)
void	OnAction (float multiplier, EActionTrigger reason)
	Bind this in your menu.
void	AddActionListenersDelayed (int delay)
	Activate / deactivate in your menu.
void	AddActionListeners ()
void	RemoveActionListeners ()

Protected Attributes
ref array< ref SCR_MenuActionPreset >	m_aActions
int	m_iDelay
bool	m_bHasActionListeners
ref array< SCR_MenuActionPreset >	m_aPressActions = {}
ref array< SCR_MenuActionPreset >	m_aValueActions = {}
ref ScriptInvokerAction	m_OnAction
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

ActivateActions()

void SCR_MenuActionsComponent.ActivateActions

(

)

AddActionListeners()

void SCR_MenuActionsComponent.AddActionListeners ( )

protected

AddActionListenersDelayed()

void SCR_MenuActionsComponent.AddActionListenersDelayed ( int  delay )

protected

Activate / deactivate in your menu.

Tried calling this on focus gained / lost, but if the menu is not focused the component gets deactivated As of now, if a button press closes a menu and that button's action is active in the menu below, it may get triggered immediatly, thus the delayed activation. This is already being investigated by the Enfusion guys

DeactivateActions()

void SCR_MenuActionsComponent.DeactivateActions

(

)

FindComponent()

static SCR_MenuActionsComponent SCR_MenuActionsComponent.FindComponent ( Widget  w )

static

GetActions()

array< ref SCR_MenuActionPreset > SCR_MenuActionsComponent.GetActions

(

)

GetOnAction()

ScriptInvokerAction SCR_MenuActionsComponent.GetOnAction

(

)

HandlerAttached()

override void SCR_MenuActionsComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

HandlerDeattached()

override void SCR_MenuActionsComponent.HandlerDeattached

(

Widget

w

)

OnAction()

void SCR_MenuActionsComponent.OnAction ( float  multiplier, EActionTrigger  reason  )

protected

Bind this in your menu.

We might be in a hidden tab or menu, in which case we don't want the invoker to trigger

OnMenuDeactivated()

void SCR_MenuActionsComponent.OnMenuDeactivated ( ChimeraMenuBase  menu )

protected

RemoveActionListeners()

void SCR_MenuActionsComponent.RemoveActionListeners ( )

protected

Member Data Documentation

m_aActions

ref array<ref SCR_MenuActionPreset> SCR_MenuActionsComponent.m_aActions

protected

m_aPressActions

ref array<SCR_MenuActionPreset> SCR_MenuActionsComponent.m_aPressActions = {}

protected

m_aValueActions

ref array<SCR_MenuActionPreset> SCR_MenuActionsComponent.m_aValueActions = {}

protected

m_bHasActionListeners

bool SCR_MenuActionsComponent.m_bHasActionListeners

protected

m_iDelay

int SCR_MenuActionsComponent.m_iDelay

protected

m_OnAction

ref ScriptInvokerAction SCR_MenuActionsComponent.m_OnAction

protected

---

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

• Game/UI/Components/SCR_MenuActionsComponent.c