SCR_EditableGroupComponentClass Interface Reference

Inheritance diagram for SCR_EditableGroupComponentClass:

Static Public Member Functions
static override bool	GetEntitySourceBudgetCost (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)
	Gets entity budget cost values from EditableEntity component source.
static bool	GetGroupSourceBudgetCost (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)
	Use when you need to get a set budget values for the group and don't want to relay on default logic where AI budget is deducted by individually spawned AI.
Static Public Member Functions inherited from SCR_EditableEntityComponentClass
static ResourceName	GetRandomVariant (ResourceName prefab)
	Get random variant of the given ResourceName (needs to have a editable entity component)
static bool	HasVariants (ResourceName prefab)
	If any variants were assigned to the prefab (Does not check if the variants are valid)
static IEntityComponentSource	GetEditableEntitySource (Resource entityResource)
	Get component source from prefab resource.
static IEntityComponentSource	GetEditableEntitySource (IEntitySource entitySource)
	Get component source from entity source.
static SCR_EditableEntityUIInfo	GetInfo (IEntityComponentSource componentSource)
	Get UI info from SCR_EditableEntityComponent source.
static EEditableEntityType	GetEntityType (IEntityComponentSource componentSource)
	Get entity system type.
static SCR_EditableEntityInteraction	GetEntityInteraction (IEntityComponentSource componentSource)
	Get entity interaction rules of this entity prefab.
static ResourceName	GetSlotPrefab (IEntityComponentSource componentSource)
	Get slot prefab from SCR_EditableEntityComponent source.
static EEditableEntityFlag	GetEntityFlags (IEntityComponentSource componentSource)
	Get entity flags.
static bool	HasFlag (IEntityComponentSource componentSource, EEditableEntityFlag flag)
	Check if the SCR_EditableEntityComponent source has given flag.
static bool	GetEntitySourceBudgetCost (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)
	Gets entity budget cost values from EditableEntity component source.
static bool	GetEntitySourceChildrenBudgetCosts (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)
	Gets entity + entity children budget cost values from EditableEntity component source.

Additional Inherited Members
Public Member Functions inherited from SCR_EditableEntityComponentClass
EEditableEntityType	GetEntityType ()
	Get entity type.
SCR_UIInfo	GetInfo ()
	Get information about the entity.
string	GetIconBoneName ()
	Get bone name on which entity icon will be rendered.
SCR_EditableEntityInteraction	GetEntityInteraction ()
	Get entity interaction rules of this entity.
Protected Attributes inherited from SCR_EditableEntityComponentClass
EEditableEntityType	m_EntityType
ref SCR_UIInfo	m_UIInfo
string	m_sIconBoneName
ref SCR_EditableEntityInteraction	m_EntityInteraction
ref SCR_EditableEntityVariantData	m_VariantData

Member Function Documentation

GetEntitySourceBudgetCost()

static override bool SCR_EditableGroupComponentClass.GetEntitySourceBudgetCost ( IEntityComponentSource  editableEntitySource, out notnull array< ref SCR_EntityBudgetValue >  budgetValues  )

static

Gets entity budget cost values from EditableEntity component source.

Parameters

[in]	editableEntitySource	Component source of the SCR_EditableEntityComponent
[out]	budgetValues	Output array filled with budget cost values

Returns

true if the component source is valid and component source has budget costs defined

Implements SCR_EditableEntityComponentClass.

GetGroupSourceBudgetCost()

static bool SCR_EditableGroupComponentClass.GetGroupSourceBudgetCost ( IEntityComponentSource  editableEntitySource, out notnull array< ref SCR_EntityBudgetValue >  budgetValues  )

static

Use when you need to get a set budget values for the group and don't want to relay on default logic where AI budget is deducted by individually spawned AI.

---

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

• Game/Editor/Components/EditableEntity/SCR_EditableGroupComponent.c