SCR_MenuActionsComponent.c File Reference

Go to the source code of this file.

Data Structures
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. More...
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
protected void	OnMenuDeactivated (ChimeraMenuBase menu)
protected void	OnAction (float multiplier)
	Bind this in your menu. More...
protected void	AddActionListenersDelayed (int delay)
protected void	AddActionListeners ()
protected void	RemoveActionListeners ()
void	ActivateActions ()
void	DeactivateActions ()
array< ref SCR_MenuActionPreset >	GetActions ()
ScriptInvokerAction	GetOnAction ()
SCR_MenuActionsComponent SCR_ScriptedWidgetComponent	SCR_BaseContainerCustomTitleField ("m_sActionName")

Variables
protected ref array< ref SCR_MenuActionPreset >	m_aActions
protected int	m_iDelay
protected bool	m_bHasActionListeners
protected 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

(

)

Definition at line 127 of file SCR_MenuActionsComponent.c.

AddActionListeners()

protected void BaseContainerProps::AddActionListeners

(

)

Definition at line 85 of file SCR_MenuActionsComponent.c.

AddActionListenersDelayed()

protected void BaseContainerProps::AddActionListenersDelayed

(

int

delay

)

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 76 of file SCR_MenuActionsComponent.c.

BaseContainerProps()

SCR_MenuActionsComponent SCR_ScriptedWidgetComponent BaseContainerProps

(

)

Configuration for an action.

DeactivateActions()

void BaseContainerProps::DeactivateActions

(

)

Definition at line 133 of file SCR_MenuActionsComponent.c.

GetActions()

array<ref SCR_MenuActionPreset> BaseContainerProps::GetActions

(

)

Definition at line 142 of file SCR_MenuActionsComponent.c.

GetOnAction()

ScriptInvokerAction BaseContainerProps::GetOnAction

(

)

Definition at line 148 of file SCR_MenuActionsComponent.c.

HandlerAttached()

override void BaseContainerProps::HandlerAttached

(

Widget

w

)

Definition at line 18 of file SCR_MenuActionsComponent.c.

HandlerDeattached()

override void BaseContainerProps::HandlerDeattached

(

Widget

w

)

Definition at line 30 of file SCR_MenuActionsComponent.c.

OnAction()

protected void BaseContainerProps::OnAction

(

float

multiplier

)

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 56 of file SCR_MenuActionsComponent.c.

OnMenuDeactivated()

protected void BaseContainerProps::OnMenuDeactivated

(

ChimeraMenuBase

menu

)

Definition at line 45 of file SCR_MenuActionsComponent.c.

RemoveActionListeners()

protected void BaseContainerProps::RemoveActionListeners

(

)

Definition at line 106 of file SCR_MenuActionsComponent.c.

SCR_BaseContainerCustomTitleField()

SCR_MenuActionsComponent SCR_ScriptedWidgetComponent SCR_BaseContainerCustomTitleField

(

"m_sActionName"

)

Definition at line 169 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

protected ref array<ref SCR_MenuActionPreset> m_aActions

Definition at line 8 of file SCR_MenuActionsComponent.c.

m_bHasActionListeners

protected bool m_bHasActionListeners

Definition at line 13 of file SCR_MenuActionsComponent.c.

m_iDelay

protected int m_iDelay

Definition at line 11 of file SCR_MenuActionsComponent.c.

m_OnAction

protected ref ScriptInvokerAction m_OnAction

Definition at line 15 of file SCR_MenuActionsComponent.c.