Inheritance diagram for SCR_CampaignBuildingPlacingHQBaseEditorComponent:

Public Member Functions
void	OnPreviewCreated (notnull SCR_EditablePreviewEntity previewEntity)
	Method called once the preview is spawned to initiate all the variables.

bool	CanCreate (out ENotification outNotification=-1, out SCR_EPreviewState previewStateToShow=SCR_EPreviewState.PLACEABLE)
	Check the preview position. Is suitable to build the composition here?

bool	IsNearAnyHQ (out ENotification outNotification=-1)

Public Member Functions inherited from SCR_BaseEditorComponent
void	OnInitBase ()

void	OnDeleteBase ()

void	OnRequestBase (bool isOpen)

void	OnOpenedBase ()

void	OnClosedBase ()

void	OnPreActivateBase ()

void	OnActivateBase ()

bool	OnActivateAsyncBase (int attempt)

void	OnPostActivateBase ()

void	OnDeactivateBase ()

void	OnPostDeactivateBase ()

bool	OnDeactivateAsyncBase (int attempt)

void	OnEffectBase (SCR_BaseEditorEffect effect)

SCR_EditorManagerEntity	GetManager ()
	Get editor manager this component belongs to.

SCR_BaseEditorComponent	FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false)
	Get the editor manager to which this component belongs.

EntityComponentPrefabData	GetEditorComponentData ()
	Get prefab data of this component.

bool	IsRemoved ()
	Check if the component is being deleted.

void	ResetEditorComponent ()
	Reset values controlled by the component.

ScriptInvoker	GetOnEffect ()
	Get event called when an effect is activated.

void	InitServer ()

void	InitOwner ()

override void	OnPostInit (IEntity owner)

void	SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_BaseEditorComponent ()

Protected Member Functions
override void	EOnEditorOpen ()
	When the editor is opened.

override void	EOnEditorClose ()
	When the editor is closed.

bool	IsSelectedPrefabHQ ()

bool	IsPreviewOutOfTaskRange (out ENotification outNotification=-1)

IEntity	GetTransformingEntity ()

Protected Member Functions inherited from SCR_BaseEditorComponent
bool	IsOnEditorManager ()

bool	IsOwner ()

bool	IsProxy ()

bool	IsMaster ()

bool	IsAdmin ()

SCR_BaseEditorComponent	GetParentComponent ()

void	SetParentComponent (SCR_BaseEditorComponent parent)

void	SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)

void	EOnEditorInit ()
	When the entity is created.

void	EOnEditorDelete ()
	When the entity is destroyed.

void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorPreActivate ()
	Before the component is activated.

void	EOnEditorActivate ()
	When the component is activated.

bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.

void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

void	EOnEditorDeactivate ()
	When the component is deactivated.

bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.

void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.

void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

void	EOnEffect (SCR_BaseEditorEffect effect)
	When an effect is created in reaction an an event.

void	EOnEditorInitServer ()
	When the entity is created (called on server)

void	EOnEditorDeleteServer ()
	When the entity is destroyed (called on server)

void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

void	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

void	EOnEditorCloseServerCallback ()
	When the editor is closed (called on server after async loading finished on client)

void	EOnEditorActivateServer ()
	When the component is activated (called on server)

void	EOnEditorDeactivateServer ()
	When the component is deactivated (called on server)

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseEditorComponent
static Managed	GetInstance (TypeName type, bool showError=false, bool modeFirst=false)
	Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity).

static Managed	GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false)
	Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity).

static int	GetAllInstances (TypeName type, out notnull array< Managed > outComponents)
	Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Member Function Documentation

◆ CanCreate()

bool SCR_CampaignBuildingPlacingHQBaseEditorComponent.CanCreate	(	out ENotification	outNotification = -1,
		out SCR_EPreviewState	previewStateToShow = SCR_EPreviewState::PLACEABLE )

Check the preview position. Is suitable to build the composition here?

◆ EOnEditorClose()

override void SCR_CampaignBuildingPlacingHQBaseEditorComponent.EOnEditorClose ( )

protected

When the editor is closed.

Implements SCR_BaseEditorComponent.

◆ EOnEditorOpen()

override void SCR_CampaignBuildingPlacingHQBaseEditorComponent.EOnEditorOpen ( )

protected

When the editor is opened.

Implements SCR_BaseEditorComponent.

◆ GetTransformingEntity()

IEntity SCR_CampaignBuildingPlacingHQBaseEditorComponent.GetTransformingEntity ( )

protected

◆ IsNearAnyHQ()

bool SCR_CampaignBuildingPlacingHQBaseEditorComponent.IsNearAnyHQ ( out ENotification outNotification = -1 )

Parameters

[out] outNotification

Returns: true if is near any HQ

◆ IsPreviewOutOfTaskRange()

bool SCR_CampaignBuildingPlacingHQBaseEditorComponent.IsPreviewOutOfTaskRange ( out ENotification outNotification = -1 )

protected

◆ IsSelectedPrefabHQ()

bool SCR_CampaignBuildingPlacingHQBaseEditorComponent.IsSelectedPrefabHQ ( )

protected

◆ OnPreviewCreated()

void SCR_CampaignBuildingPlacingHQBaseEditorComponent.OnPreviewCreated ( notnull SCR_EditablePreviewEntity previewEntity )

Method called once the preview is spawned to initiate all the variables.

Member Data Documentation

◆ m_bIsSelectedPrefabHQ

bool SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_bIsSelectedPrefabHQ

protected

◆ m_BuildingManagerComponent

SCR_CampaignBuildingManagerComponent SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_BuildingManagerComponent

protected

◆ m_Campaign

SCR_GameModeCampaign SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_Campaign

protected

◆ m_Faction

Faction SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_Faction

protected

◆ m_FactionCommanderHandler

SCR_CampaignFactionCommanderHandlerComponent SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_FactionCommanderHandler

protected

◆ m_iBaseEstablishingRadius

int SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_iBaseEstablishingRadius

protected

◆ m_iMinDistanceFromHQSq

int SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_iMinDistanceFromHQSq

protected

◆ m_PreviewEntity

SCR_EditablePreviewEntity SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_PreviewEntity

protected

◆ m_PreviewManager

SCR_PreviewEntityEditorComponent SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_PreviewManager

protected

◆ m_TransformingComponent

SCR_CampaignBuildingTransformingEditorComponent SCR_CampaignBuildingPlacingHQBaseEditorComponent.m_TransformingComponent

protected

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

Game/Editor/Components/Editor/SCR_CampaignBuildingPlacingHQBaseEditorComponent.c

Protected Attributes
SCR_EditablePreviewEntity	m_PreviewEntity

SCR_CampaignBuildingManagerComponent	m_BuildingManagerComponent

SCR_GameModeCampaign	m_Campaign

SCR_PreviewEntityEditorComponent	m_PreviewManager

SCR_CampaignBuildingTransformingEditorComponent	m_TransformingComponent

SCR_CampaignFactionCommanderHandlerComponent	m_FactionCommanderHandler

bool	m_bIsSelectedPrefabHQ

int	m_iMinDistanceFromHQSq

int	m_iBaseEstablishingRadius

Faction	m_Faction

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CanCreate()

◆ EOnEditorClose()

◆ EOnEditorOpen()

◆ GetTransformingEntity()

◆ IsNearAnyHQ()

◆ IsPreviewOutOfTaskRange()

◆ IsSelectedPrefabHQ()

◆ OnPreviewCreated()

Member Data Documentation

◆ m_bIsSelectedPrefabHQ

◆ m_BuildingManagerComponent

◆ m_Campaign

◆ m_Faction

◆ m_FactionCommanderHandler

◆ m_iBaseEstablishingRadius

◆ m_iMinDistanceFromHQSq

◆ m_PreviewEntity

◆ m_PreviewManager

◆ m_TransformingComponent