SCR_EditableEntityComponentClass Interface Reference

Inheritance diagram for SCR_EditableEntityComponentClass:

Public Member Functions
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.

Static Public Member Functions
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.

Protected Attributes
EEditableEntityType	m_EntityType
ref SCR_UIInfo	m_UIInfo
string	m_sIconBoneName
ref SCR_EditableEntityInteraction	m_EntityInteraction
ref SCR_EditableEntityVariantData	m_VariantData

Member Function Documentation

GetEditableEntitySource() [1/2]

static IEntityComponentSource SCR_EditableEntityComponentClass.GetEditableEntitySource ( IEntitySource  entitySource )

static

Get component source from entity source.

Parameters

[in]

entitySource

Entity source - cannot be null

Returns

Component source

GetEditableEntitySource() [2/2]

static IEntityComponentSource SCR_EditableEntityComponentClass.GetEditableEntitySource ( Resource  entityResource )

static

Get component source from prefab resource.

Parameters

[in]

entityResource

loaded entity prefab, use Resource.Load(prefab) to retrieve it from ResourceName

Returns

Component source

GetEntityFlags()

static EEditableEntityFlag SCR_EditableEntityComponentClass.GetEntityFlags ( IEntityComponentSource  componentSource )

static

Get entity flags.

Parameters

[in]

componentSource

Component source

Returns

Flags

GetEntityInteraction() [1/2]

SCR_EditableEntityInteraction SCR_EditableEntityComponentClass.GetEntityInteraction

(

)

Get entity interaction rules of this entity.

If it doesn't contain any custom rules, those for its type will be used.

Returns

Interaction rules

GetEntityInteraction() [2/2]

static SCR_EditableEntityInteraction SCR_EditableEntityComponentClass.GetEntityInteraction ( IEntityComponentSource  componentSource )

static

Get entity interaction rules of this entity prefab.

If it doesn't contain any custom rules, those for its type will be used.

Parameters

[in]

componentSource

Component source - cannot be null

Returns

Interaction rules

GetEntitySourceBudgetCost()

static bool SCR_EditableEntityComponentClass.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

Implemented in SCR_EditableFactionComponentClass, and SCR_EditableGroupComponentClass.

GetEntitySourceChildrenBudgetCosts()

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

static

Gets entity + entity children 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

GetEntityType() [1/2]

EEditableEntityType SCR_EditableEntityComponentClass.GetEntityType

(

)

Get entity type.

Returns

Type

GetEntityType() [2/2]

static EEditableEntityType SCR_EditableEntityComponentClass.GetEntityType ( IEntityComponentSource  componentSource )

static

Get entity system type.

Parameters

[in]

componentSource

Component source - cannot be null

Returns

Type

GetIconBoneName()

string SCR_EditableEntityComponentClass.GetIconBoneName

(

)

Get bone name on which entity icon will be rendered.

Returns

Bone name

GetInfo() [1/2]

SCR_UIInfo SCR_EditableEntityComponentClass.GetInfo

(

)

Get information about the entity.

When none exist, create a dummy one.

Returns

Info class

GetInfo() [2/2]

static SCR_EditableEntityUIInfo SCR_EditableEntityComponentClass.GetInfo ( IEntityComponentSource  componentSource )

static

Get UI info from SCR_EditableEntityComponent source.

Parameters

[in]

componentSource

Component source - cannot be null

Returns

UI info

GetRandomVariant()

static ResourceName SCR_EditableEntityComponentClass.GetRandomVariant ( ResourceName  prefab )

static

Get random variant of the given ResourceName (needs to have a editable entity component)

Parameters

[in]

prefab

The default variant. It will be used to get the variants from as well as potentially adding it to the randomization pool depending on the settings

Returns

Prefab variant or default if no variant found (or randomly selected)

GetSlotPrefab()

static ResourceName SCR_EditableEntityComponentClass.GetSlotPrefab ( IEntityComponentSource  componentSource )

static

Get slot prefab from SCR_EditableEntityComponent source.

Parameters

[in]

componentSource

Component source - cannot be null

Returns

Slot prefab

HasFlag()

static bool SCR_EditableEntityComponentClass.HasFlag ( IEntityComponentSource  componentSource, EEditableEntityFlag  flag  )

static

Check if the SCR_EditableEntityComponent source has given flag.

Parameters

[in]	componentSource	Component source
[in]	flag	Queried flag

Returns

true if it has the flag

HasVariants()

static bool SCR_EditableEntityComponentClass.HasVariants ( ResourceName  prefab )

static

If any variants were assigned to the prefab (Does not check if the variants are valid)

Parameters

[in]

prefab

Prefab to check default variants of

Returns

True if any variants were assigned

Member Data Documentation

m_EntityInteraction

ref SCR_EditableEntityInteraction SCR_EditableEntityComponentClass.m_EntityInteraction

protected

m_EntityType

EEditableEntityType SCR_EditableEntityComponentClass.m_EntityType

protected

m_sIconBoneName

string SCR_EditableEntityComponentClass.m_sIconBoneName

protected

m_UIInfo

ref SCR_UIInfo SCR_EditableEntityComponentClass.m_UIInfo

protected

m_VariantData

ref SCR_EditableEntityVariantData SCR_EditableEntityComponentClass.m_VariantData

protected

---

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

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