SCR_MenuActionsComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_MenuActionsComponent

Typedefs
typedef func	ScriptInvokerActionMethod
typedef ScriptInvokerBase< ScriptInvokerActionMethod >	ScriptInvokerAction

Functions
void	ScriptInvokerActionMethod (string name, float multiplier)
SCR_MenuActionsComponent SCR_ScriptedWidgetComponent	BaseContainerProps ()
	Configuration for an action.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	OnMenuDeactivated (ChimeraMenuBase menu)
void	OnAction (float multiplier, EActionTrigger reason)
	Bind this in your menu.
void	AddActionListenersDelayed (int delay)
void	AddActionListeners ()
void	RemoveActionListeners ()
void	ActivateActions ()
void	DeactivateActions ()
array< ref SCR_MenuActionPreset >	GetActions ()
ScriptInvokerAction	GetOnAction ()
SCR_MenuActionsComponent SCR_ScriptedWidgetComponent	SCR_BaseContainerCustomTitleField ("m_sActionName")

Variables
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

Typedef Documentation

ScriptInvokerAction

typedef ScriptInvokerBase<ScriptInvokerActionMethod> ScriptInvokerAction

Definition at line 6 of file SCR_MenuActionsComponent.c.

ScriptInvokerActionMethod

typedef func ScriptInvokerActionMethod

Definition at line 5 of file SCR_MenuActionsComponent.c.

Function Documentation

ActivateActions()

void BaseContainerProps::ActivateActions ( )

protected

Definition at line 171 of file SCR_MenuActionsComponent.c.

AddActionListeners()

void BaseContainerProps::AddActionListeners ( )

protected

Definition at line 129 of file SCR_MenuActionsComponent.c.

AddActionListenersDelayed()

void BaseContainerProps::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

Definition at line 120 of file SCR_MenuActionsComponent.c.

BaseContainerProps()

SCR_MenuActionsComponent SCR_ScriptedWidgetComponent BaseContainerProps

(

)

Configuration for an action.

DeactivateActions()

void BaseContainerProps::DeactivateActions ( )

protected

Definition at line 177 of file SCR_MenuActionsComponent.c.

GetActions()

array< ref SCR_MenuActionPreset > BaseContainerProps::GetActions ( )

protected

Definition at line 186 of file SCR_MenuActionsComponent.c.

GetOnAction()

ScriptInvokerAction BaseContainerProps::GetOnAction ( )

protected

Definition at line 192 of file SCR_MenuActionsComponent.c.

HandlerAttached()

override void BaseContainerProps::HandlerAttached ( Widget w )

protected

Definition at line 14 of file SCR_MenuActionsComponent.c.

HandlerDeattached()

override void BaseContainerProps::HandlerDeattached ( Widget w )

protected

Definition at line 47 of file SCR_MenuActionsComponent.c.

OnAction()

void BaseContainerProps::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

Definition at line 73 of file SCR_MenuActionsComponent.c.

OnMenuDeactivated()

void BaseContainerProps::OnMenuDeactivated ( ChimeraMenuBase menu )

protected

Definition at line 62 of file SCR_MenuActionsComponent.c.

RemoveActionListeners()

void BaseContainerProps::RemoveActionListeners ( )

protected

Definition at line 150 of file SCR_MenuActionsComponent.c.

SCR_BaseContainerCustomTitleField()

SCR_MenuActionsComponent SCR_ScriptedWidgetComponent SCR_BaseContainerCustomTitleField

(

"m_sActionName"

)

Definition at line 220 of file SCR_MenuActionsComponent.c.

ScriptInvokerActionMethod()

void ScriptInvokerActionMethod	(	string	name,
		float	multiplier )

Handles activating action listeners when the menu is focused. Requires the menu to be handled by a child of MenuRootBase, and the actions to be in an active context

Variable Documentation

m_aActions

ref array<ref SCR_MenuActionPreset> m_aActions

protected

Definition at line 1 of file SCR_MenuActionsComponent.c.

m_aPressActions

ref array<SCR_MenuActionPreset> m_aPressActions = {}

protected

Definition at line 8 of file SCR_MenuActionsComponent.c.

m_aValueActions

ref array<SCR_MenuActionPreset> m_aValueActions = {}

protected

Definition at line 9 of file SCR_MenuActionsComponent.c.

m_bHasActionListeners

bool m_bHasActionListeners

protected

Definition at line 6 of file SCR_MenuActionsComponent.c.

m_iDelay

int m_iDelay

protected

Definition at line 4 of file SCR_MenuActionsComponent.c.

m_OnAction

ref ScriptInvokerAction m_OnAction

protected

Definition at line 11 of file SCR_MenuActionsComponent.c.