SCR_SpawnOccupantsContextAction Interface Reference

Inheritance diagram for SCR_SpawnOccupantsContextAction:

Public Member Functions
override bool	CanBeShown (SCR_EditableEntityComponent selectedEntity, vector cursorWorldPosition, int flags)
	Helper function for actions that should be performed on multiple entities, avoids having foreach loops in each subclass.
override bool	CanBePerformed (SCR_EditableEntityComponent selectedEntity, vector cursorWorldPosition, int flags)
override void	Perform (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
	Perform action.
override void	Perform (SCR_EditableEntityComponent selectedEntity, vector cursorWorldPosition)
	Perform function for each selected entity.
Public Member Functions inherited from SCR_SelectedEntitiesContextAction
override bool	CanBeShown (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
	Determine if action can be shown with passed hovered entity and selected entitites.
override bool	CanBePerformed (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
	Determine if action can be performed with passed hovered entity and selected entitites.
override void	PerformOwner (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
bool	InitPerform ()
	Helper function to execute code before performing the action on all entities, called only once (eg.
void	PerformOwner (SCR_EditableEntityComponent selectedEntity, vector cursorWorldPosition)
	Perform function for each selected entity, executed on owner, player that executed the action.
Public Member Functions inherited from SCR_BaseContextAction
override bool	IsServer ()
	Should action be sent to server.
Public Member Functions inherited from SCR_BaseEditorAction
bool	IsEnabled ()
SCR_UIInfo	GetInfo ()
EEditorActionType	GetActionType ()
EEditorActionGroup	GetActionGroup ()
string	GetShortcut ()
	Get action shortcut that triggers this action.
void	SetShortcutRef (string shortcutRef)
	Set shortcut reference - it's shown in GUI, but not actually listened to.
int	GetOrder ()
	Get order of this entity, can be any integer value including negative.
int	GetParam ()
	Get custom param which can be used to pass extra information to performed action.
array< ref SCR_BaseEditorEffect >	GetEffects ()
	Get effects tied to the action.
void	AddShortcut (SCR_BaseActionsEditorComponent actionsManager)
void	RemoveShortcut ()
bool	CheckAndSetCooldown ()
	Check if action is on cooldown and if not set action on cooldown The cooldown will never be set if cooldownTime is equal or less than 0.
bool	IsOnCooldown ()
	Check if action is on cooldown.
void	~SCR_BaseEditorAction ()

Protected Member Functions
void	SpawnNextOccupantsInEntity (SCR_BaseCompartmentManagerComponent compartmentManager=null, array< IEntity > spawnedCharacters=null, bool wasCanceled=false)
void	SetSpawningDone ()
Protected Member Functions inherited from SCR_BaseEditorAction
void	OnShortcut ()
void	ActivateCooldown ()
void	UpdateCooldown ()
void	OnCooldownDone ()

Protected Attributes
ref array< ECompartmentType >	m_aCompartmentsTypes
ref map< SCR_BaseCompartmentManagerComponent, SCR_EditableVehicleComponent >	m_VehiclesToOccupyQueue = new map<SCR_BaseCompartmentManagerComponent, SCR_EditableVehicleComponent>()
bool	m_bHasSendNotEnoughBudgetNotification = false
bool	m_bIsSpawningOccupants = false
Protected Attributes inherited from SCR_BaseEditorAction
bool	m_bEnabled
ref SCR_UIInfo	m_Info
EEditorActionType	m_ActionType
EEditorActionGroup	m_ActionGroup
int	m_iOrder
string	m_sShortcut
bool	m_bEnableShortcutLogics
ref array< ref SCR_BaseEditorEffect >	m_Effects
SCR_BaseActionsEditorComponent	m_ActionsManager
string	m_sShortcutRef
float	m_fCooldownTime
float	m_fCurrentCooldownTime
float	m_fCooldownUpdateFreq = 50
bool	m_bShowOnCooldownNotification
bool	m_bIsOnCooldown

Member Function Documentation

CanBePerformed()

override bool SCR_SpawnOccupantsContextAction.CanBePerformed	(	SCR_EditableEntityComponent	selectedEntity,
		vector	cursorWorldPosition,
		int	flags )

Implements SCR_SelectedEntitiesContextAction.

CanBeShown()

override bool SCR_SpawnOccupantsContextAction.CanBeShown	(	SCR_EditableEntityComponent	selectedEntity,
		vector	cursorWorldPosition,
		int	flags )

Helper function for actions that should be performed on multiple entities, avoids having foreach loops in each subclass.

Parameters

selectedEntity

Current selectedEntities iteration

Implements SCR_SelectedEntitiesContextAction.

Perform() [1/2]

override void SCR_SpawnOccupantsContextAction.Perform	(	SCR_EditableEntityComponent	hoveredEntity,
		notnull set< SCR_EditableEntityComponent >	selectedEntities,
		vector	cursorWorldPosition,
		int	flags,
		int	param = -1 )

Perform action.

Implements SCR_SelectedEntitiesContextAction.

Perform() [2/2]

override void SCR_SpawnOccupantsContextAction.Perform	(	SCR_EditableEntityComponent	selectedEntity,
		vector	cursorWorldPosition )

Perform function for each selected entity.

Parameters

selectedEntity	Current selectedEntities iteration
cursorWorldPosition	Cursor world position

Implements SCR_SelectedEntitiesContextAction.

SetSpawningDone()

void SCR_SpawnOccupantsContextAction.SetSpawningDone ( )

protected

SpawnNextOccupantsInEntity()

void SCR_SpawnOccupantsContextAction.SpawnNextOccupantsInEntity ( SCR_BaseCompartmentManagerComponent compartmentManager = null, array< IEntity > spawnedCharacters = null, bool wasCanceled = false )

protected

Member Data Documentation

m_aCompartmentsTypes

ref array<ECompartmentType> SCR_SpawnOccupantsContextAction.m_aCompartmentsTypes

protected

m_bHasSendNotEnoughBudgetNotification

bool SCR_SpawnOccupantsContextAction.m_bHasSendNotEnoughBudgetNotification = false

protected

m_bIsSpawningOccupants

bool SCR_SpawnOccupantsContextAction.m_bIsSpawningOccupants = false

protected

m_VehiclesToOccupyQueue

ref map<SCR_BaseCompartmentManagerComponent, SCR_EditableVehicleComponent> SCR_SpawnOccupantsContextAction.m_VehiclesToOccupyQueue = new map<SCR_BaseCompartmentManagerComponent, SCR_EditableVehicleComponent>()

protected

---

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

• Game/Editor/Containers/Actions/ContextActions/SCR_SpawnOccupantsContextAction.c