SCR_EditableGroupComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_EditableGroupComponentClass

Functions
protected void	OnAgentAdded (AIAgent child)
protected void	OnAgentRemoved (SCR_AIGroup group, AIAgent child)
protected void	OnLeaderChanged (AIAgent currentLeader, AIAgent prevLeader)
protected void	OnCurrentWaypointChanged (AIWaypoint currentWP, AIWaypoint prevWP)
protected void	OnWaypointCompleted (AIWaypoint wp)
protected void	OnWaypointAdded (AIWaypoint wp)
protected void	OnWaypointRemoved (AIWaypoint wp)
protected void	ReindexWaypoints ()
protected void	OnLeaderIdChanged ()
protected void	SetLeader (SCR_EditableEntityComponent leader)
protected void	OnFactionChanged (Faction faction)
protected void	OnIdentityChange (SCR_MilitarySymbol symbol, LocalizedString name)
SCR_AIGroup	GetAIGroupComponent ()
override ScriptInvoker	GetOnUIRefresh ()
override Faction	GetFaction ()
override SCR_EditableEntityComponent	GetAIGroup ()
override SCR_EditableEntityComponent	GetAIEntity ()
int	GetSize ()
int	GetWaypointCount ()
void	ClearWaypoints ()
	Remove all waypoints from the group. More...
override bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets, IEntity owner=null)
void	GetRuntimeBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
void	GetPrefabBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
override bool	CanDuplicate (out notnull set< SCR_EditableEntityComponent > outRecipients)
override SCR_EditableEntityComponent	GetChild (int index)
override bool	GetPos (out vector pos)
override bool	CanDestroy ()
override bool	IsDestroyed ()
void	HideIfEmpty ()
override bool	Destroy ()
override void	ForceVehicleCompartments (notnull array< ECompartmentType > forceVehicleCompartments)
override void	OnParentEntityChanged (SCR_EditableEntityComponent parentEntity, SCR_EditableEntityComponent parentEntityPrev, bool changedByUser)
override void	OnCreatedServer (notnull SCR_PlacingEditorComponent placedEditorComponent)
void	OnAllMembersSpawned (SCR_AIGroup group)
override void	OnChildEntityChanged (SCR_EditableEntityComponent child, bool isAdded)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
void	SCR_EditableGroupComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
SCR_EditableGroupComponentClass	m_Group
	Special configuration for editable group. More...
protected RplId	m_LeaderId
protected SCR_EditableEntityComponent	m_Leader
protected ref SCR_EditableGroupUIInfo	m_GroupInfo
protected ref ScriptInvoker	Event_OnUIRefresh = new ScriptInvoker
protected ref array< ECompartmentType >	m_aForceSpawnVehicleCompartments
protected SCR_PlacingEditorComponent	m_PlacedEditorComponent

Function Documentation

CanDestroy()

override bool CanDestroy

(

)

Definition at line 418 of file SCR_EditableGroupComponent.c.

CanDuplicate()

override bool CanDuplicate

(

out notnull set< SCR_EditableEntityComponent >

outRecipients

)

Definition at line 386 of file SCR_EditableGroupComponent.c.

ClearWaypoints()

void ClearWaypoints

(

)

Remove all waypoints from the group.

Definition at line 295 of file SCR_EditableGroupComponent.c.

Destroy()

override bool Destroy

(

)

Definition at line 460 of file SCR_EditableGroupComponent.c.

ForceVehicleCompartments()

override void ForceVehicleCompartments

(

notnull array< ECompartmentType >

forceVehicleCompartments

)

Definition at line 490 of file SCR_EditableGroupComponent.c.

GetAIEntity()

override SCR_EditableEntityComponent GetAIEntity

(

)

Definition at line 256 of file SCR_EditableGroupComponent.c.

GetAIGroup()

override SCR_EditableEntityComponent GetAIGroup

(

)

Definition at line 250 of file SCR_EditableGroupComponent.c.

GetAIGroupComponent()

SCR_AIGroup GetAIGroupComponent

(

)

Get ai group component, server only

Returns

m_Group

Definition at line 224 of file SCR_EditableGroupComponent.c.

GetChild()

override SCR_EditableEntityComponent GetChild

(

int

index

)

Definition at line 392 of file SCR_EditableGroupComponent.c.

GetEntityBudgetCost()

override bool GetEntityBudgetCost	(	out notnull array< ref SCR_EntityBudgetValue >	outBudgets,
		IEntity	owner = null
	)

Definition at line 317 of file SCR_EditableGroupComponent.c.

GetFaction()

override Faction GetFaction

(

)

Definition at line 236 of file SCR_EditableGroupComponent.c.

GetOnUIRefresh()

override ScriptInvoker GetOnUIRefresh

(

)

Definition at line 230 of file SCR_EditableGroupComponent.c.

GetPos()

override bool GetPos

(

out vector

pos

)

Definition at line 405 of file SCR_EditableGroupComponent.c.

GetPrefabBudgetCost()

void GetPrefabBudgetCost

(

out notnull array< ref SCR_EntityBudgetValue >

outBudgets

)

Definition at line 350 of file SCR_EditableGroupComponent.c.

GetRuntimeBudgetCost()

void GetRuntimeBudgetCost

(

out notnull array< ref SCR_EntityBudgetValue >

outBudgets

)

Definition at line 324 of file SCR_EditableGroupComponent.c.

GetSize()

int GetSize

(

)

Get number of group members.

Returns

Number of group members

Definition at line 264 of file SCR_EditableGroupComponent.c.

GetWaypointCount()

int GetWaypointCount

(

)

Get count of all waypoints of this group

Returns

Number of waypoints

Definition at line 275 of file SCR_EditableGroupComponent.c.

HideIfEmpty()

void HideIfEmpty

(

)

Definition at line 449 of file SCR_EditableGroupComponent.c.

IsDestroyed()

override bool IsDestroyed

(

)

Definition at line 433 of file SCR_EditableGroupComponent.c.

OnAgentAdded()

protected void OnAgentAdded

(

AIAgent

child

)

Definition at line 51 of file SCR_EditableGroupComponent.c.

OnAgentRemoved()

protected void OnAgentRemoved	(	SCR_AIGroup	group,
		AIAgent	child
	)

Definition at line 63 of file SCR_EditableGroupComponent.c.

OnAllMembersSpawned()

void OnAllMembersSpawned

(

SCR_AIGroup

group

)

Parameters

[in]

group

Definition at line 578 of file SCR_EditableGroupComponent.c.

OnChildEntityChanged()

override void OnChildEntityChanged	(	SCR_EditableEntityComponent	child,
		bool	isAdded
	)

Definition at line 597 of file SCR_EditableGroupComponent.c.

OnCreatedServer()

override void OnCreatedServer

(

notnull SCR_PlacingEditorComponent

placedEditorComponent

)

Definition at line 552 of file SCR_EditableGroupComponent.c.

OnCurrentWaypointChanged()

protected void OnCurrentWaypointChanged	(	AIWaypoint	currentWP,
		AIWaypoint	prevWP
	)

Definition at line 92 of file SCR_EditableGroupComponent.c.

OnFactionChanged()

protected void OnFactionChanged

(

Faction

faction

)

Definition at line 189 of file SCR_EditableGroupComponent.c.

OnIdentityChange()

protected void OnIdentityChange	(	SCR_MilitarySymbol	symbol,
		LocalizedString	name
	)

Definition at line 206 of file SCR_EditableGroupComponent.c.

OnLeaderChanged()

protected void OnLeaderChanged	(	AIAgent	currentLeader,
		AIAgent	prevLeader
	)

Definition at line 75 of file SCR_EditableGroupComponent.c.

OnLeaderIdChanged()

protected void OnLeaderIdChanged

(

)

Definition at line 172 of file SCR_EditableGroupComponent.c.

OnParentEntityChanged()

override void OnParentEntityChanged	(	SCR_EditableEntityComponent	parentEntity,
		SCR_EditableEntityComponent	parentEntityPrev,
		bool	changedByUser
	)

Definition at line 502 of file SCR_EditableGroupComponent.c.

OnWaypointAdded()

protected void OnWaypointAdded

(

AIWaypoint

wp

)

Definition at line 104 of file SCR_EditableGroupComponent.c.

OnWaypointCompleted()

protected void OnWaypointCompleted

(

AIWaypoint

wp

)

Definition at line 98 of file SCR_EditableGroupComponent.c.

OnWaypointRemoved()

protected void OnWaypointRemoved

(

AIWaypoint

wp

)

Definition at line 115 of file SCR_EditableGroupComponent.c.

ReindexWaypoints()

protected void ReindexWaypoints

(

)

Definition at line 126 of file SCR_EditableGroupComponent.c.

SCR_EditableGroupComponent()

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

Parameters

[in]	src
[in]	ent
[in]	parent

Definition at line 703 of file SCR_EditableGroupComponent.c.

SetLeader()

protected void SetLeader

(

SCR_EditableEntityComponent

leader

)

Definition at line 179 of file SCR_EditableGroupComponent.c.

Variable Documentation

Event_OnUIRefresh

protected ref ScriptInvoker Event_OnUIRefresh = new ScriptInvoker

Definition at line 38 of file SCR_EditableGroupComponent.c.

m_aForceSpawnVehicleCompartments

protected ref array<ECompartmentType> m_aForceSpawnVehicleCompartments

Definition at line 41 of file SCR_EditableGroupComponent.c.

m_GroupInfo

protected ref SCR_EditableGroupUIInfo m_GroupInfo

Definition at line 37 of file SCR_EditableGroupComponent.c.

m_Leader

protected SCR_EditableEntityComponent m_Leader

Definition at line 36 of file SCR_EditableGroupComponent.c.

m_LeaderId

protected RplId m_LeaderId

Definition at line 34 of file SCR_EditableGroupComponent.c.

m_PlacedEditorComponent

protected SCR_PlacingEditorComponent m_PlacedEditorComponent

Definition at line 43 of file SCR_EditableGroupComponent.c.