SCR_EntityCatalogSpawnerData Interface Reference

Info for Entity Spawner. More...

Inheritance diagram for SCR_EntityCatalogSpawnerData:

Public Member Functions
void	SetEnabled (bool enable)
	Set the enabled state of the entity in the spawner Changing this in runtime will allow/disallow certain entities to spawn for factions.
int	GetEntityCount ()
LocalizedString	GetOverwriteName ()
	Get Localized overwrite name Empty if no name is overwritten.
bool	CanSpawnInSlot (SCR_EEntitySpawnerSlotType slotSize)
	Check if entity can be spawned in slot of given size.
SCR_EEntitySpawnerSlotType	GetValidSlotSizes ()
	Get flags of valid slot sizes.
bool	HasRequiredRank (SCR_ECharacterRank rank)
	Check if entity can be spawned by player with specific rank Will check if given rank is equal or greater then minimum required rank.
SCR_ECharacterRank	GetMinimumRequiredRank ()
	Get the minimum required rank.
int	GetSupplyCost ()
	Get supply cost of spawning Entity.
ResourceName	GetRandomDefaultOrVariantPrefab ()
	Get random variant or default prefab.
int	GetVariantDataList (notnull out array< SCR_SpawnerVariantData > variantData)
	Get list of all variant data.
int	GetVariantPrefabList (notnull out array< ResourceName > variantPrefabs)
	Get list of all variant prefabs.
SCR_SpawnerVariantData	GetVariantDataOfType (ESpawnerVariantType variantType)
	Get specific variant data of type if it exists.
ResourceName	GetVariantPrefabOfType (ESpawnerVariantType variantType)
	Get specific variant Prefab of type if it exists.
override void	InitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog on creation.
Public Member Functions inherited from SCR_BaseEntityCatalogData
bool	IsEnabled ()
	If is Enabled.
void	InitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog on creation.
void	PostInitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog after init data is called for all other entries.

Protected Attributes
ref SCR_UIInfo	m_UiInfo
SCR_EEntitySpawnerSlotType	m_eSlotTypes
int	m_iEntityCount
ref array< ref SCR_SpawnerVariantData >	m_aVariantData
ResourceName	m_sDefaultPrefab
SCR_ECharacterRank	m_eMinimumRequiredRank
int	m_iSupplyCost
Protected Attributes inherited from SCR_BaseEntityCatalogData
bool	m_bEnabled

Detailed Description

Info for Entity Spawner.

Member Function Documentation

CanSpawnInSlot()

bool SCR_EntityCatalogSpawnerData.CanSpawnInSlot

(

SCR_EEntitySpawnerSlotType

slotSize

)

Check if entity can be spawned in slot of given size.

Parameters

slotSize

Slot size to check

Returns

Returns true if entity can spawn in given slot size

GetEntityCount()

int SCR_EntityCatalogSpawnerData.GetEntityCount

(

)

GetMinimumRequiredRank()

SCR_ECharacterRank SCR_EntityCatalogSpawnerData.GetMinimumRequiredRank

(

)

Get the minimum required rank.

Returns

Returns the minimum required rank

GetOverwriteName()

LocalizedString SCR_EntityCatalogSpawnerData.GetOverwriteName

(

)

Get Localized overwrite name Empty if no name is overwritten.

Returns

Localized overwrite name

GetRandomDefaultOrVariantPrefab()

ResourceName SCR_EntityCatalogSpawnerData.GetRandomDefaultOrVariantPrefab

(

)

Get random variant or default prefab.

Returns

Random variant or default prefab

GetSupplyCost()

int SCR_EntityCatalogSpawnerData.GetSupplyCost

(

)

Get supply cost of spawning Entity.

Returns

Supply cost

GetValidSlotSizes()

SCR_EEntitySpawnerSlotType SCR_EntityCatalogSpawnerData.GetValidSlotSizes

(

)

Get flags of valid slot sizes.

Returns

Valid slot sizes flags

GetVariantDataList()

int SCR_EntityCatalogSpawnerData.GetVariantDataList

(

notnull out array< SCR_SpawnerVariantData >

variantData

)

Get list of all variant data.

Parameters

[out]

variantData

List of variant data

Returns

length of variant data array

GetVariantDataOfType()

SCR_SpawnerVariantData SCR_EntityCatalogSpawnerData.GetVariantDataOfType

(

ESpawnerVariantType

variantType

)

Get specific variant data of type if it exists.

Parameters

Type	of variant to find

Returns

Variant data (or null if not found)

GetVariantPrefabList()

int SCR_EntityCatalogSpawnerData.GetVariantPrefabList

(

notnull out array< ResourceName >

variantPrefabs

)

Get list of all variant prefabs.

Parameters

[out]

variantData

List of variant prefabs

Returns

length of variant prefab array

GetVariantPrefabOfType()

ResourceName SCR_EntityCatalogSpawnerData.GetVariantPrefabOfType

(

ESpawnerVariantType

variantType

)

Get specific variant Prefab of type if it exists.

Parameters

Type	of variant to find

Returns

Variant prefab (or empty if not found)

HasRequiredRank()

bool SCR_EntityCatalogSpawnerData.HasRequiredRank

(

SCR_ECharacterRank

rank

)

Check if entity can be spawned by player with specific rank Will check if given rank is equal or greater then minimum required rank.

Parameters

rank	Rank of player that request the spawn

Returns

Returns true if player has the required rank

InitData()

override void SCR_EntityCatalogSpawnerData.InitData

(

notnull SCR_EntityCatalogEntry

entry

)

Called by Catalog on creation.

Special init for data. To be overidden. Never called if Data is disabled

Parameters

[in]

entry

Entry the data is attached to

Implements SCR_BaseEntityCatalogData.

Implemented in SCR_EntityCatalogSpawnerOverrideData.

SetEnabled()

void SCR_EntityCatalogSpawnerData.SetEnabled

(

bool

enable

)

Set the enabled state of the entity in the spawner Changing this in runtime will allow/disallow certain entities to spawn for factions.

Parameters

enable

New Enabled state

Member Data Documentation

m_aVariantData

ref array<ref SCR_SpawnerVariantData> SCR_EntityCatalogSpawnerData.m_aVariantData

protected

m_eMinimumRequiredRank

SCR_ECharacterRank SCR_EntityCatalogSpawnerData.m_eMinimumRequiredRank

protected

m_eSlotTypes

SCR_EEntitySpawnerSlotType SCR_EntityCatalogSpawnerData.m_eSlotTypes

protected

m_iEntityCount

int SCR_EntityCatalogSpawnerData.m_iEntityCount

protected

m_iSupplyCost

int SCR_EntityCatalogSpawnerData.m_iSupplyCost

protected

m_sDefaultPrefab

ResourceName SCR_EntityCatalogSpawnerData.m_sDefaultPrefab

protected

m_UiInfo

ref SCR_UIInfo SCR_EntityCatalogSpawnerData.m_UiInfo

protected

---

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

• Game/EntityCatalog/EntityCatalogEntryData/SCR_EntityCatalogSpawnerData.c