SCR_BuildingDestructionManagerComponent Interface Reference

Inheritance diagram for SCR_BuildingDestructionManagerComponent:

Public Member Functions
notnull SCR_BuildingDestructionData	GetData (inout int index)
	Returns data stored at provided index.
void	FreeData (int index)
	Public to be used by objects storing data here.
array< string >	GetExcludedQueryTypes ()
int	GetDestroyedBuildings (notnull array< SCR_DestructibleBuildingComponent > destroyedBuildings)
void	RegisterDestroyedBuilding (SCR_DestructibleBuildingComponent building)
void	SCR_BuildingDestructionManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_BuildingDestructionManagerComponent ()

Static Public Member Functions
static bool	IsIdTaken (int id, SCR_DestructibleBuildingComponent building)
static int	GetNewId ()
static SCR_DestructibleBuildingComponent	GetDestructibleBuilding (int id)
static void	UnregisterBuildingId (notnull SCR_DestructibleBuildingComponent component)
static void	RegisterBuildingId (notnull SCR_DestructibleBuildingComponent component, int id)

Protected Attributes
ref SCR_BuildingDestructionConfig	m_BuildingDestructionConfig
ref array< SCR_DestructibleBuildingComponent >	m_aDestroyedBuildings = {}

Static Protected Attributes
static int	s_iHighestId
static ref map< int, SCR_DestructibleBuildingComponent >	s_mBuildingIds = new map<int, SCR_DestructibleBuildingComponent>()

Constructor & Destructor Documentation

SCR_BuildingDestructionManagerComponent()

void SCR_BuildingDestructionManagerComponent.SCR_BuildingDestructionManagerComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

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

~SCR_BuildingDestructionManagerComponent()

void SCR_BuildingDestructionManagerComponent.~SCR_BuildingDestructionManagerComponent

(

)

Member Function Documentation

FreeData()

void SCR_BuildingDestructionManagerComponent.FreeData

(

int

index

)

Public to be used by objects storing data here.

Parameters

[in]

index

GetData()

notnull SCR_BuildingDestructionData SCR_BuildingDestructionManagerComponent.GetData

(

inout int

index

)

Returns data stored at provided index.

Parameters

[in,out]

index

GetDestroyedBuildings()

int SCR_BuildingDestructionManagerComponent.GetDestroyedBuildings

(

notnull array< SCR_DestructibleBuildingComponent >

destroyedBuildings

)

Parameters

[in]

destroyedBuildings

Returns

GetDestructibleBuilding()

static SCR_DestructibleBuildingComponent SCR_BuildingDestructionManagerComponent.GetDestructibleBuilding ( int  id )

static

Parameters

[in]

id

Returns

GetExcludedQueryTypes()

array< string > SCR_BuildingDestructionManagerComponent.GetExcludedQueryTypes

(

)

Returns

array of typenames to be excluded from entity query

GetNewId()

static int SCR_BuildingDestructionManagerComponent.GetNewId ( )

static

Returns

IsIdTaken()

static bool SCR_BuildingDestructionManagerComponent.IsIdTaken ( int  id, SCR_DestructibleBuildingComponent  building  )

static

Parameters

[in]	id
[in]	building

Returns

true if id is taken by other building than "building"

RegisterBuildingId()

static void SCR_BuildingDestructionManagerComponent.RegisterBuildingId ( notnull SCR_DestructibleBuildingComponent  component, int  id  )

static

Parameters

[in]	component
[in]	id

RegisterDestroyedBuilding()

void SCR_BuildingDestructionManagerComponent.RegisterDestroyedBuilding

(

SCR_DestructibleBuildingComponent

building

)

Parameters

[in]

building

UnregisterBuildingId()

static void SCR_BuildingDestructionManagerComponent.UnregisterBuildingId ( notnull SCR_DestructibleBuildingComponent  component )

static

Parameters

[in]

component

Member Data Documentation

m_aDestroyedBuildings

ref array<SCR_DestructibleBuildingComponent> SCR_BuildingDestructionManagerComponent.m_aDestroyedBuildings = {}

protected

m_BuildingDestructionConfig

ref SCR_BuildingDestructionConfig SCR_BuildingDestructionManagerComponent.m_BuildingDestructionConfig

protected

s_iHighestId

int SCR_BuildingDestructionManagerComponent.s_iHighestId

staticprotected

s_mBuildingIds

ref map<int, SCR_DestructibleBuildingComponent> SCR_BuildingDestructionManagerComponent.s_mBuildingIds = new map<int, SCR_DestructibleBuildingComponent>()

staticprotected

---

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

• Game/Destruction/SCR_BuildingDestructionManagerComponent.c