SCR_EntityCatalogSpawnerData Class Reference

Inheritance diagram for SCR_EntityCatalogSpawnerData:

Protected Member Functions
Set the enabled state of the entity in the spawner Changing this in runtime will allow disallow certain entities to spawn for factions param enable New Enabled state *void	SetEnabled (bool enable)
int	GetEntityCount ()
Get Localized overwrite name Empty if no name is overwritten return Localized overwrite name *LocalizedString	GetOverwriteName ()
Check if entity can be spawned in slot of given size param slotSize Slot size to check return Returns true if entity can spawn in given slot size *bool	CanSpawnInSlot (SCR_EEntitySpawnerSlotType slotSize)
Get flags of valid slot sizes return Valid slot sizes flags *SCR_EEntitySpawnerSlotType	GetValidSlotSizes ()
Check if entity can be spawned by player with specific rank Will check if given rank is equal or greater then minimum required rank param rank Rank of player that request the spawn return Returns true if player has the required rank *bool	HasRequiredRank (SCR_ECharacterRank rank)
Get the minimum required rank return Returns the minimum required rank *SCR_ECharacterRank	GetMinimumRequiredRank ()
Get supply cost of spawning Entity return Supply cost *int	GetSupplyCost ()
Get random variant or default prefab return Random variant or default prefab *ResourceName	GetRandomDefaultOrVariantPrefab ()
Get list of all variant data param[out] variantData List of variant data return length of variant data array *int	GetVariantDataList (notnull out array< SCR_SpawnerVariantData > variantData)
Get list of all variant prefabs param[out] variantData List of variant prefabs return length of variant prefab array *int	GetVariantPrefabList (notnull out array< ResourceName > variantPrefabs)
Get specific variant data of type if it exists param Type of variant to find return Variant	data (or null if not found) */SCR_SpawnerVariantData GetVariantDataOfType(ESpawnerVariantType variantType)
Get specific variant Prefab of type if it exists param Type of variant to find return Variant	prefab (or empty if not found) */ResourceName GetVariantPrefabOfType(ESpawnerVariantType variantType)
override void	InitData (notnull SCR_EntityCatalogEntry entry)

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

Detailed Description

Info for Entity Spawner

Definition at line 5 of file SCR_EntityCatalogSpawnerData.c.

Member Function Documentation

CanSpawnInSlot()

Check if entity can be spawned in slot of given size param slotSize Slot size to check return Returns true if entity can spawn in given slot size *bool SCR_EntityCatalogSpawnerData::CanSpawnInSlot ( SCR_EEntitySpawnerSlotType slotSize )

inlineprotected

Definition at line 62 of file SCR_EntityCatalogSpawnerData.c.

data()

Get specific variant data of type if it exists param Type of variant to find return Variant SCR_EntityCatalogSpawnerData::data ( or null if not found )

inlineprotected

Definition at line 174 of file SCR_EntityCatalogSpawnerData.c.

GetEntityCount()

int SCR_EntityCatalogSpawnerData::GetEntityCount ( )

inlineprotected

Definition at line 37 of file SCR_EntityCatalogSpawnerData.c.

GetMinimumRequiredRank()

Get the minimum required rank return Returns the minimum required rank *SCR_ECharacterRank SCR_EntityCatalogSpawnerData::GetMinimumRequiredRank ( )

inlineprotected

Definition at line 97 of file SCR_EntityCatalogSpawnerData.c.

GetOverwriteName()

Get Localized overwrite name Empty if no name is overwritten return Localized overwrite name *LocalizedString SCR_EntityCatalogSpawnerData::GetOverwriteName ( )

inlineprotected

Definition at line 48 of file SCR_EntityCatalogSpawnerData.c.

GetRandomDefaultOrVariantPrefab()

Get random variant or default prefab return Random variant or default prefab *ResourceName SCR_EntityCatalogSpawnerData::GetRandomDefaultOrVariantPrefab ( )

inlineprotected

Definition at line 117 of file SCR_EntityCatalogSpawnerData.c.

GetSupplyCost()

Get supply cost of spawning Entity return Supply cost *int SCR_EntityCatalogSpawnerData::GetSupplyCost ( )

inlineprotected

Definition at line 107 of file SCR_EntityCatalogSpawnerData.c.

GetValidSlotSizes()

Get flags of valid slot sizes return Valid slot sizes flags *SCR_EEntitySpawnerSlotType SCR_EntityCatalogSpawnerData::GetValidSlotSizes ( )

inlineprotected

Definition at line 72 of file SCR_EntityCatalogSpawnerData.c.

GetVariantDataList()

Get list of all variant data param[out] variantData List of variant data return length of variant data array *int SCR_EntityCatalogSpawnerData::GetVariantDataList ( notnull out array< SCR_SpawnerVariantData > variantData )

inlineprotected

Definition at line 140 of file SCR_EntityCatalogSpawnerData.c.

GetVariantPrefabList()

Get list of all variant prefabs param[out] variantData List of variant prefabs return length of variant prefab array *int SCR_EntityCatalogSpawnerData::GetVariantPrefabList ( notnull out array< ResourceName > variantPrefabs )

inlineprotected

Definition at line 158 of file SCR_EntityCatalogSpawnerData.c.

HasRequiredRank()

Check if entity can be spawned by player with specific rank Will check if given rank is equal or greater then minimum required rank param rank Rank of player that request the spawn return Returns true if player has the required rank *bool SCR_EntityCatalogSpawnerData::HasRequiredRank ( SCR_ECharacterRank rank )

inlineprotected

Definition at line 84 of file SCR_EntityCatalogSpawnerData.c.

InitData()

override void SCR_EntityCatalogSpawnerData::InitData ( notnull SCR_EntityCatalogEntry entry )

inlineprotected

Definition at line 203 of file SCR_EntityCatalogSpawnerData.c.

prefab()

Get specific variant Prefab of type if it exists param Type of variant to find return Variant SCR_EntityCatalogSpawnerData::prefab ( or empty if not found )

inlineprotected

Definition at line 191 of file SCR_EntityCatalogSpawnerData.c.

SetEnabled()

Set the enabled state of the entity in the spawner Changing this in runtime will allow disallow certain entities to spawn for factions param enable New Enabled state *void SCR_EntityCatalogSpawnerData::SetEnabled ( bool enable )

inlineprotected

Definition at line 31 of file SCR_EntityCatalogSpawnerData.c.

Member Data Documentation

m_aVariantData

ref array<ref SCR_SpawnerVariantData> SCR_EntityCatalogSpawnerData::m_aVariantData

protected

Definition at line 17 of file SCR_EntityCatalogSpawnerData.c.

m_eMinimumRequiredRank

SCR_ECharacterRank SCR_EntityCatalogSpawnerData::m_eMinimumRequiredRank

protected

Definition at line 21 of file SCR_EntityCatalogSpawnerData.c.

m_eSlotTypes

SCR_EEntitySpawnerSlotType SCR_EntityCatalogSpawnerData::m_eSlotTypes

protected

Definition at line 11 of file SCR_EntityCatalogSpawnerData.c.

m_iEntityCount

int SCR_EntityCatalogSpawnerData::m_iEntityCount

protected

Definition at line 14 of file SCR_EntityCatalogSpawnerData.c.

m_iSupplyCost

int SCR_EntityCatalogSpawnerData::m_iSupplyCost

protected

Definition at line 23 of file SCR_EntityCatalogSpawnerData.c.

m_sDefaultPrefab

ResourceName SCR_EntityCatalogSpawnerData::m_sDefaultPrefab

protected

Definition at line 19 of file SCR_EntityCatalogSpawnerData.c.

m_UiInfo

ref SCR_UIInfo SCR_EntityCatalogSpawnerData::m_UiInfo

protected

Definition at line 8 of file SCR_EntityCatalogSpawnerData.c.

---

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

• scripts/Game/EntityCatalog/EntityCatalogEntryData/SCR_EntityCatalogSpawnerData.c