Data Structures
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)

protected 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)

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

protected TraceFlags	GetInstantActionTraceFlags ()

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

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

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

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

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

protected 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. More...

private void	SerializeEntities (out RplId hoveredEntityId, out array< RplId > selectedEntityIds)

private bool	GetRplIdFromEditableEntity (SCR_EditableEntityComponent entity, out RplId entityRplId)

private void	DeSerializeEntities (RplId hoveredEntityId, array< RplId > selectedEntityIds, out SCR_EditableEntityComponent hoveredEntityComponent, out set< SCR_EditableEntityComponent > selectedEntityComponents)

private bool	GetEditableEntityFromRplId (RplId entityRplId, out SCR_EditableEntityComponent editableEntityComponent)

override void	EOnEditorActivate ()

override void	EOnEditorDeactivate ()

Variables
EEditorActionGroup	m_ActionGroup

int	m_iOrder

ref SCR_SortedArray< SCR_BaseEditorAction >	m_aActions

SCR_BaseActionsEditorComponentClass	m_HoverManager

protected SCR_BaseEditableEntityFilter	m_SelectedManager

protected SCR_MenuLayoutEditorComponent	m_MenuLayoutManager

protected SCR_EditableEntityComponent	m_HoveredEntity

protected ref set< SCR_EditableEntityComponent >	m_SelectedEntities = new set<SCR_EditableEntityComponent>()

Function Documentation

◆ ActionCanBePerformed()

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

Parameters

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

Returns

Definition at line 242 of file SCR_BaseActionsEditorComponent.c.

◆ ActionCanBeShown()

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

Parameters

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

Returns

Definition at line 231 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerform() [1/2]

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

Definition at line 327 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerform() [2/2]

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

Perform given action

Parameters

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

Definition at line 288 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformInstantly()

void ActionPerformInstantly	(	SCR_BaseEditorAction	action,
		int	flags = `0`
	)

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 251 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformInstantlyNoDialog()

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

Definition at line 264 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformLocal()

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

Definition at line 333 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformOwner()

protected 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.

Definition at line 374 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformRpc()

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

Definition at line 309 of file SCR_BaseActionsEditorComponent.c.

◆ ActionPerformServer()

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

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 349 of file SCR_BaseActionsEditorComponent.c.

◆ BaseContainerProps()

class SCR_EditorActionGroup BaseContainerProps ( configRoot:true )

Definition at line 13 of file SCR_BaseActionsEditorComponent.c.

◆ DeSerializeEntities()

private void DeSerializeEntities	(	RplId	hoveredEntityId,
		array< RplId >	selectedEntityIds,
		out SCR_EditableEntityComponent	hoveredEntityComponent,
		out set< SCR_EditableEntityComponent >	selectedEntityComponents
	)

Definition at line 426 of file SCR_BaseActionsEditorComponent.c.

◆ EOnEditorActivate()

override void EOnEditorActivate ( )

Definition at line 463 of file SCR_BaseActionsEditorComponent.c.

◆ EOnEditorDeactivate()

override void EOnEditorDeactivate ( )

Definition at line 482 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`
	)

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 184 of file SCR_BaseActionsEditorComponent.c.

◆ GetActions()

int GetActions ( out notnull array< SCR_BaseEditorAction > actions )

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 168 of file SCR_BaseActionsEditorComponent.c.

◆ GetAndEvaluateActions()

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

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