Inheritance diagram for SCR_CampaignBuildingEditableEntityFilter:

[legend]

Public Member Functions
override bool	CanAdd (SCR_EditableEntityComponent entity)
	Check if the entity meets condition for this entity state.

Public Member Functions inherited from SCR_BaseEditableEntityFilter
void	InitVariables (SCR_EntitiesManagerEditorComponent manager, SCR_BaseEditableEntityFilter predecessor)

EEditableEntityState	GetState ()
	Get entity state this component is managing.

string	GetStateName ()
	Get name of the entity state this component is managing.

EEditableEntityState	GetPredecessorState ()
	Get entity state of the component which preceeds this one.

SCR_BaseEditableEntityFilter	GetPredecessor ()
	Get component which preceeds this one.

EEditableEntityFilterAutoAdd	GetAutoAdd ()
	Check if entities can be registered automatically based on predecessor component.

int	GetEntities (out set< SCR_EditableEntityComponent > entities, bool includeChildren=false, bool evaluate=true)
	Get entities managed by this filter.

int	GetEntitiesCount ()
	Get number of cached entities.

bool	IsEmpty ()
	Check if the filter contains any entities.

SCR_EditableEntityComponent	GetFirstEntity ()
	Get the first cached entity.

bool	Contains (SCR_EditableEntityComponent entity)
	Check if given entity is among cached entities.

ScriptInvokerBase< SCR_BaseEditableEntityFilter_OnChange >	GetOnChanged ()
	Get script invoker which is triggered every time some entities are added or removed.

void	Log ()
	Print all cached entities to the log.

void	OnFrameBase (float timeSlice)

void	OnActivateBase ()

void	OnDeactivateBase ()

bool	Add (SCR_EditableEntityComponent entityInsert, bool onlyDirect=false)
	Register given entity.

bool	Add (notnull set< SCR_EditableEntityComponent > entitiesInsert, bool onlyDirect=false)
	Register multiple entities.

bool	Remove (SCR_EditableEntityComponent entityRemove, bool onlyDirect=false)
	Unregister given entity.

bool	Remove (notnull set< SCR_EditableEntityComponent > entitiesRemove, bool onlyDirect=false)
	Unregister multiple entities.

bool	Toggle (SCR_EditableEntityComponent entity, bool onlyDirect=false)
	Toggle state of given entity, i.e., register it if it's unregistered and unregister it if it's registered.

bool	Toggle (notnull set< SCR_EditableEntityComponent > entities, bool onlyDirect=false)
	Toggle state of given entities, i.e., register them if they're unregistered and unregister them if they're registered.

bool	Replace (SCR_EditableEntityComponent entityInsert, bool onlyDirect=false, bool keepExisting=false)
	Replace cached array with given entity.

bool	Replace (set< SCR_EditableEntityComponent > entitiesInsert, bool onlyDirect=false, bool keepExisting=false)
	Replace cached array with entities.

bool	Set (SCR_EditableEntityComponent entityInsert, SCR_EditableEntityComponent entityRemove, bool onlyDirect=false)
	Register and unregister entities in one go.

bool	Set (set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove, bool onlyDirect=false)
	Register and unregister entities in one go.

bool	SetFromPredecessor ()
	Fill the list from the predecessor.

bool	Validate (SCR_EditableEntityComponent entity)
	If the entity is added to the filter, check if its condition is still valid.

bool	Clear ()
	Clear cached array.

bool	Copy (SCR_BaseEditableEntityFilter filter, bool onlyDirect=false)
	Copy the list of registered entities from another filter.

Protected Member Functions
bool	GetComposition (IEntity owner, out SCR_EditableEntityComponent entity, out SCR_CampaignBuildingCompositionComponent composition)

bool	IsCompositionOwned (IEntity owner)

bool	CanAddCharacter (notnull IEntity char)

bool	CanAddWaypoint (notnull IEntity waypoint)

bool	IsInBaseArea (notnull IEntity ent, int buffer=0)
	Check if the given entity is within a base radius.

void	OnEntityRefreshed (SCR_EditableEntityComponent entity)
	Add given entity to the list so it's icon is shown in.

SCR_CampaignBuildingProviderComponent	GetProviderComponent ()
	Return provider component of this mode.

Protected Member Functions inherited from SCR_BaseEditableEntityFilter
int	GetEntitiesPointer (out set< SCR_EditableEntityComponent > entities)

SCR_EditableEntityComponent	GetParentBelowCurrentLayer (SCR_EditableEntityComponent entity)

sealed SCR_EntitiesManagerEditorComponent	GetManager ()

sealed SCR_EditableEntityCore	GetCore ()

void	InitEntities ()

void	OnChanged (set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)

void	OnChanged ()

sealed void	InsertChildren (out set< SCR_EditableEntityComponent > entities)

sealed bool	AddToArray (SCR_EditableEntityComponent entity, out bool isChange, bool returnWhenExists=false)

sealed bool	RemoveFromArray (SCR_EditableEntityComponent entity, out bool isChange)

void	EOnEditorActivate ()
	When the editor is opened (before cached array is intialized)

void	EOnEditorDeactivate ()
	When the editor is closed (after cached array is destroyed)

void	EOnEditorFrame (float timeSlice)
	Every frame while the editor is opened.

Static Protected Attributes
const int	AI_SEARCH_BUFFER_DISTANCE = 20

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseEditableEntityFilter
static SCR_BaseEditableEntityFilter	GetInstance (EEditableEntityState state, bool showError=false)
	Get current filter instance.

static SCR_EditableEntityComponent	GetFirstEntity (EEditableEntityState state)
	Get first entity of given filter type.

static int	GetEnititiesStatic (out set< SCR_EditableEntityComponent > entities, EEditableEntityState state, bool includeChildren=false, bool evaluate=true)
	Get first entity of given filter type.

Protected Attributes inherited from SCR_BaseEditableEntityFilter
EEditableEntityState	m_State

EEditableEntityState	m_PredecessorState

EEditableEntityFilterAutoAdd	m_bAutoAdd

bool	m_bSkipIgnored

bool	m_bOnlyInteractive

SCR_EditableEntityCore	m_Core

SCR_EntitiesManagerEditorComponent	m_Manager

SCR_BaseEditableEntityFilter	m_Predecessor

ref set< SCR_EditableEntityComponent >	m_Entities

int	m_iEntitiesCount

string	m_sStateName = "N/A"

ref ScriptInvokerBase< SCR_BaseEditableEntityFilter_OnChange >	m_OnChange = new ScriptInvokerBase<SCR_BaseEditableEntityFilter_OnChange>()

Member Function Documentation

◆ CanAdd()

override bool SCR_CampaignBuildingEditableEntityFilter.CanAdd ( SCR_EditableEntityComponent entity )

Check if the entity meets condition for this entity state.

Parameters

entity Editable entity

Returns: True if the condition is met

Implements SCR_BaseEditableEntityFilter.

◆ CanAddCharacter()

bool SCR_CampaignBuildingEditableEntityFilter.CanAddCharacter ( notnull IEntity char )

protected

Parameters

[in] char Character entity to test.

◆ CanAddWaypoint()

bool SCR_CampaignBuildingEditableEntityFilter.CanAddWaypoint ( notnull IEntity waypoint )

protected

Parameters

[in] waypoint waypoint entity to test.

◆ GetComposition()

bool SCR_CampaignBuildingEditableEntityFilter.GetComposition	(	IEntity	owner,
		out SCR_EditableEntityComponent	entity,
		out SCR_CampaignBuildingCompositionComponent	composition
	)

protected

◆ GetProviderComponent()

SCR_CampaignBuildingProviderComponent SCR_CampaignBuildingEditableEntityFilter.GetProviderComponent ( )

protected

Return provider component of this mode.

◆ IsCompositionOwned()

bool SCR_CampaignBuildingEditableEntityFilter.IsCompositionOwned ( IEntity owner )

protected

◆ IsInBaseArea()

bool SCR_CampaignBuildingEditableEntityFilter.IsInBaseArea	(	notnull IEntity	ent,
		int	buffer = `0`
	)

protected

Check if the given entity is within a base radius.

Parameters

[in]	ent	Entity to be tested
[in]	buffer	int Additional distance to add to the radius of the building zone where the entity can be added. For example an AI that can wander away.

◆ OnEntityRefreshed()

void SCR_CampaignBuildingEditableEntityFilter.OnEntityRefreshed ( SCR_EditableEntityComponent entity )

protected

Add given entity to the list so it's icon is shown in.

Member Data Documentation

◆ AI_SEARCH_BUFFER_DISTANCE

const int SCR_CampaignBuildingEditableEntityFilter.AI_SEARCH_BUFFER_DISTANCE = 20

staticprotected

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

Game/Editor/Containers/EditableEntityFilters/SCR_CampaignBuildingEditableEntityFilter.c

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CanAdd()

◆ CanAddCharacter()

◆ CanAddWaypoint()

◆ GetComposition()

◆ GetProviderComponent()

◆ IsCompositionOwned()

◆ IsInBaseArea()

◆ OnEntityRefreshed()

Member Data Documentation

◆ AI_SEARCH_BUFFER_DISTANCE