SCR_CommandActionsEditorComponent Class Reference

Inheritance diagram for SCR_CommandActionsEditorComponent:

Protected Member Functions
ScriptInvoker	GetOnCurrentActionChanged ()
bool	IsActionCurrent (SCR_BaseEditorAction action)
void	SetCurrentAction (SCR_BaseEditorAction currentAction)
void	PerformDefaultAction (bool isQueue)
void	StartPlacing (SCR_BaseEditorAction action)
void	OnPlacingSelectedPrefabChange (ResourceName prefab, ResourceName prefabPrev)
override int	ValidateSelection (bool isInstant)
TraceFlags	GetInstantActionTraceFlags ()
override bool	ActionCanBeShown (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags)
override bool	ActionCanBePerformed (SCR_BaseEditorAction action, vector cursorWorldPosition, int flags)
override void	EOnEditorActivate ()
override void	EOnEditorDeactivate ()

Protected Attributes
ref array< EEditorActionGroup >	m_DefaultActionGroups
SCR_BaseEditorAction	m_CurrentAction
ref ScriptInvoker	Event_OnCurrentActionChanged = new ScriptInvoker()

Detailed Description

Manager of command actions, i.e., waypoint for AI groups or objectives for factions.

Definition at line 10 of file SCR_CommandActionsEditorComponent.c.

Member Function Documentation

ActionCanBePerformed()

override bool SCR_CommandActionsEditorComponent::ActionCanBePerformed ( SCR_BaseEditorAction action, vector cursorWorldPosition, int flags )

inlineprotected

Definition at line 137 of file SCR_CommandActionsEditorComponent.c.

ActionCanBeShown()

override bool SCR_CommandActionsEditorComponent::ActionCanBeShown ( SCR_BaseEditorAction action, vector cursorWorldPosition, int flags )

inlineprotected

Definition at line 132 of file SCR_CommandActionsEditorComponent.c.

EOnEditorActivate()

override void SCR_CommandActionsEditorComponent::EOnEditorActivate ( )

inlineprotected

Definition at line 142 of file SCR_CommandActionsEditorComponent.c.

EOnEditorDeactivate()

override void SCR_CommandActionsEditorComponent::EOnEditorDeactivate ( )

inlineprotected

Definition at line 150 of file SCR_CommandActionsEditorComponent.c.

GetInstantActionTraceFlags()

TraceFlags SCR_CommandActionsEditorComponent::GetInstantActionTraceFlags ( )

inlineprotected

Definition at line 127 of file SCR_CommandActionsEditorComponent.c.

GetOnCurrentActionChanged()

ScriptInvoker SCR_CommandActionsEditorComponent::GetOnCurrentActionChanged ( )

inlineprotected

Get handler called when current action changes.

Returns

Script invoker

Definition at line 23 of file SCR_CommandActionsEditorComponent.c.

IsActionCurrent()

bool SCR_CommandActionsEditorComponent::IsActionCurrent ( SCR_BaseEditorAction action )

inlineprotected

Check if given action is currently selected one.

Parameters

action

Queried action

Returns

True when current

Definition at line 32 of file SCR_CommandActionsEditorComponent.c.

OnPlacingSelectedPrefabChange()

void SCR_CommandActionsEditorComponent::OnPlacingSelectedPrefabChange ( ResourceName prefab, ResourceName prefabPrev )

inlineprotected

Definition at line 83 of file SCR_CommandActionsEditorComponent.c.

PerformDefaultAction()

void SCR_CommandActionsEditorComponent::PerformDefaultAction ( bool isQueue )

inlineprotected

Instantly place a command.

Parameters

isQueue

True when adding to, not replacing existing commands

Definition at line 50 of file SCR_CommandActionsEditorComponent.c.

SetCurrentAction()

void SCR_CommandActionsEditorComponent::SetCurrentAction ( SCR_BaseEditorAction currentAction )

inlineprotected

Set action as current.

Parameters

action

Action

Definition at line 40 of file SCR_CommandActionsEditorComponent.c.

StartPlacing()

void SCR_CommandActionsEditorComponent::StartPlacing ( SCR_BaseEditorAction action )

inlineprotected

Start placing of a command.

Parameters

action

Action representing the command

Definition at line 74 of file SCR_CommandActionsEditorComponent.c.

ValidateSelection()

override int SCR_CommandActionsEditorComponent::ValidateSelection ( bool isInstant )

inlineprotected

Definition at line 92 of file SCR_CommandActionsEditorComponent.c.

Member Data Documentation

Event_OnCurrentActionChanged

ref ScriptInvoker SCR_CommandActionsEditorComponent::Event_OnCurrentActionChanged = new ScriptInvoker()

protected

Definition at line 17 of file SCR_CommandActionsEditorComponent.c.

m_CurrentAction

SCR_BaseEditorAction SCR_CommandActionsEditorComponent::m_CurrentAction

protected

Definition at line 15 of file SCR_CommandActionsEditorComponent.c.

m_DefaultActionGroups

ref array<EEditorActionGroup> SCR_CommandActionsEditorComponent::m_DefaultActionGroups

protected

Definition at line 13 of file SCR_CommandActionsEditorComponent.c.

---

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

• scripts/Game/Editor/Components/Editor/SCR_CommandActionsEditorComponent.c