Classes
class	SCR_EditorActionGroup
class	SCR_BaseActionsEditorComponentClass

Functions
class SCR_EditorActionGroup	BaseContainerProps (configRoot:true)
SCR_EditableEntityComponent	GetHoveredEntity ()
int	GetActions (out notnull array< SCR_BaseEditorAction > actions)
void	EvaluateActions (notnull array< SCR_BaseEditorAction > actions, vector cursorWorldPosition, out notnull array< ref SCR_EditorActionData > filteredActions, out int flags=0)
int	GetAndEvaluateActions (vector cursorWorldPosition, out notnull array< ref SCR_EditorActionData > filteredActions, out int flags=0)
int	ValidateSelection (bool isInstant)
bool	ActionCanBeShown (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags)
bool	ActionCanBePerformed (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags)
void	ActionPerformInstantly (SCR_BaseEditorAction action, int flags=0)
void	ActionPerformInstantlyNoDialog (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags=0)
TraceFlags	GetInstantActionTraceFlags ()
void	ActionPerform (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags)
void	ActionPerformRpc (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags, int param=-1)
void	ActionPerform (SCR_BaseEditorAction action, SCR_EditableEntityComponent hoveredEntityComponent, set< SCR_EditableEntityComponent > selectedEntityComponents, vector cursorWorldPosition, int flags, int param)
void	ActionPerformLocal (SCR_BaseEditorAction action, SCR_EditableEntityComponent hoveredEntityComponent, set< SCR_EditableEntityComponent > selectedEntityComponents, vector cursorWorldPosition, int flags, int param)
void	ActionPerformServer (int actionIndex, RplId hoveredEntityID, array< RplId > selectedEntityIds, vector cursorWorldPosition, int flags, int param)
void	ActionPerformOwner (int actionIndex, vector cursorWorldPosition, int flags, int param)
	Server callback for when action is executed succesfully, calls PerformOwner function on action for e.g. local effects.

Variables
EEditorActionGroup	m_ActionGroup
int	m_iOrder
ref SCR_SortedArray< SCR_BaseEditorAction >	m_aActions
SCR_BaseActionsEditorComponentClass	m_HoverManager
SCR_BaseEditableEntityFilter	m_SelectedManager
SCR_MenuLayoutEditorComponent	m_MenuLayoutManager
SCR_EditableEntityComponent	m_HoveredEntity
ref set< SCR_EditableEntityComponent >	m_SelectedEntities = new set<SCR_EditableEntityComponent>()

Function Documentation

◆ ActionCanBePerformed()

bool ActionCanBePerformed	(	SCR_BaseEditorAction	action,
		vector	cursorWorldPosition,
		int	flags )

protected

Parameters

[in]	action
[in]	cursorWorldPosition
[in]	flags

Returns

Definition at line 246 of file SCR_BaseActionsEditorComponent.c.

◆ ActionCanBeShown()

bool ActionCanBeShown	(	SCR_BaseEditorAction	action,
		vector	cursorWorldPosition,
		int	flags )

protected

Parameters

[in]	action
[in]	cursorWorldPosition
[in]	flags

Returns

Definition at line 235 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerform() [1/2]

void ActionPerform	(	SCR_BaseEditorAction	action,
		SCR_EditableEntityComponent	hoveredEntityComponent,
		set< SCR_EditableEntityComponent >	selectedEntityComponents,
		vector	cursorWorldPosition,
		int	flags,
		int	param )

protected

Definition at line 331 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerform() [2/2]

void ActionPerform	(	SCR_BaseEditorAction	action,
		vector	cursorWorldPosition,
		int	flags )

protected

Perform given action

Parameters

[in]	action
[in]	cursorWorldPosition
[in]	flags

Definition at line 292 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformInstantly()

void ActionPerformInstantly	(	SCR_BaseEditorAction	action,
		int	flags = 0 )

protected

When action shortcut is activated, check if the action can be performed and if so, perform it.

Parameters

[in]	action	Action to be performed
[in]	flags

Definition at line 255 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformInstantlyNoDialog()

void ActionPerformInstantlyNoDialog	(	SCR_BaseEditorAction	action,
		vector	cursorWorldPosition,
		int	flags = 0 )

protected

Definition at line 268 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformLocal()

void ActionPerformLocal	(	SCR_BaseEditorAction	action,
		SCR_EditableEntityComponent	hoveredEntityComponent,
		set< SCR_EditableEntityComponent >	selectedEntityComponents,
		vector	cursorWorldPosition,
		int	flags,
		int	param )

protected

Definition at line 337 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformOwner()

void ActionPerformOwner	(	int	actionIndex,
		vector	cursorWorldPosition,
		int	flags,
		int	param )

protected

Server callback for when action is executed succesfully, calls PerformOwner function on action for e.g. local effects.

Definition at line 384 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformRpc()

void ActionPerformRpc	(	SCR_BaseEditorAction	action,
		vector	cursorWorldPosition,
		int	flags,
		int	param = -1 )

protected

Definition at line 313 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformServer()

void ActionPerformServer	(	int	actionIndex,
		RplId	hoveredEntityID,
		array< RplId >	selectedEntityIds,
		vector	cursorWorldPosition,
		int	flags,
		int	param )

protected

Perform given action on server, exclusively called by ActionPerform

Parameters

[in]	actionIndex	Index of the action in the m_Actions list, same on server and client
[in]	hoveredEntityID	RplID of the hovered entity, -1 if none hovered
[in]	selectedEntityIds	RplIDs of the selected entities, empty array if none selected
[in]	cursorWorldPosition	world position where action was intitiated
[in]	flags	EEditorContextActionFlags / EEditorCommandActionFlags for placing
[in]	param	parameter obtained through SCR_BaseEditorAction.GetParam() on client, use to pass client data/ids to server

Definition at line 353 of file SCR_BaseActionsEditorComponent.c.

◆ BaseContainerProps()

class SCR_EditorActionGroup BaseContainerProps ( configRoot:true )

Definition at line 1 of file SCR_BaseActionsEditorComponent.c.

◆ EvaluateActions()

void EvaluateActions	(	notnull array< SCR_BaseEditorAction >	actions,
		vector	cursorWorldPosition,
		out notnull array< ref SCR_EditorActionData >	filteredActions,
		out int	flags = 0 )

protected

Evaluates passed list of actions for the current context

Parameters

[in]	actions	input array with all actions
[in]	cursorWorldPositioin	world positon used to evaluate actions
[out]	filteredActions	output array containing all available actions for the current context
[out]	flags	Conitions to be cached for faster evaluation in functions

Returns: Amount of available actions

Definition at line 188 of file SCR_BaseActionsEditorComponent.c.

◆ GetActions()

int GetActions ( out notnull array< SCR_BaseEditorAction > actions )

protected

Gets all actions on the component

Parameters

[out] actions output array containing all actions on this component

Returns: Amount of total actions

Definition at line 172 of file SCR_BaseActionsEditorComponent.c.

◆ GetAndEvaluateActions()

int GetAndEvaluateActions	(	vector	cursorWorldPosition,
		out notnull array< ref SCR_EditorActionData >	filteredActions,
		out int	flags = 0 )

protected

Gets and evaluates actions for current context, combination of GetActions and EvaluateActions functions

Parameters

[in]	cursorWorldPosition	world positon used to evaluate actions
[in]	filteredActions	output array containing all available actions for the current context
[in]	flags	Cached results of common conditions