Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_EditableEntityComponentClass Class Reference
Inheritance diagram for SCR_EditableEntityComponentClass:
ScriptComponentClass SCR_EditableCharacterComponentClass SCR_EditableCommentComponentClass SCR_EditableDecalComponentClass SCR_EditableFactionComponentClass SCR_EditableGroupComponentClass SCR_EditablePlayerDelegateComponentClass SCR_EditablePreviewComponentClass SCR_EditableSystemComponentClass SCR_EditableVehicleComponentClass SCR_EditableWaypointComponentClass

Protected Member Functions

EEditableEntityType GetEntityType ()
SCR_UIInfo GetInfo ()
string GetIconBoneName ()
SCR_EditableEntityInteraction GetEntityInteraction ()

Static Protected Member Functions

static ResourceName GetRandomVariant (ResourceName prefab)
static bool HasVariants (ResourceName prefab)
static IEntityComponentSource GetEditableEntitySource (Resource entityResource)
static IEntityComponentSource GetEditableEntitySource (IEntitySource entitySource)
static SCR_EditableEntityUIInfo GetInfo (IEntityComponentSource componentSource)
static EEditableEntityType GetEntityType (IEntityComponentSource componentSource)
static SCR_EditableEntityInteraction GetEntityInteraction (IEntityComponentSource componentSource)
static ResourceName GetSlotPrefab (IEntityComponentSource componentSource)
static EEditableEntityFlag GetEntityFlags (IEntityComponentSource componentSource)
static bool HasFlag (IEntityComponentSource componentSource, EEditableEntityFlag flag)
static bool GetEntitySourceBudgetCost (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)
static bool GetEntitySourceChildrenBudgetCosts (IEntityComponentSource editableEntitySource, out notnull array< ref SCR_EntityBudgetValue > budgetValues)

Protected Attributes

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

Detailed Description

Definition at line 2 of file SCR_EditableEntityComponentClass.c.

Member Function Documentation

◆ GetEditableEntitySource() [1/2]

IEntityComponentSource SCR_EditableEntityComponentClass::GetEditableEntitySource ( IEntitySource entitySource)
inlinestaticprotected

Get component source from entity source.

Parameters
[in]entitySourceEntity source - cannot be null
Returns
Component source

Definition at line 163 of file SCR_EditableEntityComponentClass.c.

◆ GetEditableEntitySource() [2/2]

IEntityComponentSource SCR_EditableEntityComponentClass::GetEditableEntitySource ( Resource entityResource)
inlinestaticprotected

Get component source from prefab resource.

Parameters
[in]entityResourceloaded entity prefab, use Resource.Load(prefab) to retrieve it from ResourceName
Returns
Component source

Definition at line 143 of file SCR_EditableEntityComponentClass.c.

◆ GetEntityFlags()

EEditableEntityFlag SCR_EditableEntityComponentClass::GetEntityFlags ( IEntityComponentSource componentSource)
inlinestaticprotected

Get entity flags

Parameters
[in]componentSourceComponent source
Returns
Flags

Definition at line 240 of file SCR_EditableEntityComponentClass.c.

◆ GetEntityInteraction() [1/2]

SCR_EditableEntityInteraction SCR_EditableEntityComponentClass::GetEntityInteraction ( )
inlineprotected

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

Definition at line 127 of file SCR_EditableEntityComponentClass.c.

◆ GetEntityInteraction() [2/2]

SCR_EditableEntityInteraction SCR_EditableEntityComponentClass::GetEntityInteraction ( IEntityComponentSource componentSource)
inlinestaticprotected

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]componentSourceComponent source - cannot be null
Returns
Interaction rules

Definition at line 208 of file SCR_EditableEntityComponentClass.c.

◆ GetEntitySourceBudgetCost()

bool SCR_EditableEntityComponentClass::GetEntitySourceBudgetCost ( IEntityComponentSource editableEntitySource,
out notnull array< ref SCR_EntityBudgetValue > budgetValues )
inlinestaticprotected

Gets entity budget cost values from EditableEntity component source

Parameters
[in]editableEntitySourceComponent source of the SCR_EditableEntityComponent
[out]budgetValuesOutput array filled with budget cost values
Returns
true if the component source is valid and component source has budget costs defined

Definition at line 265 of file SCR_EditableEntityComponentClass.c.

◆ GetEntitySourceChildrenBudgetCosts()

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

Gets entity + entity children budget cost values from EditableEntity component source

Parameters
[in]editableEntitySourceComponent source of the SCR_EditableEntityComponent
[out]budgetValuesOutput array filled with budget cost values
Returns
true if the component source is valid and component source has budget costs defined

Definition at line 282 of file SCR_EditableEntityComponentClass.c.

◆ GetEntityType() [1/2]

EEditableEntityType SCR_EditableEntityComponentClass::GetEntityType ( )
inlineprotected

Get entity type.

Returns
Type

Definition at line 103 of file SCR_EditableEntityComponentClass.c.

◆ GetEntityType() [2/2]

EEditableEntityType SCR_EditableEntityComponentClass::GetEntityType ( IEntityComponentSource componentSource)
inlinestaticprotected

Get entity system type

Parameters
[in]componentSourceComponent source - cannot be null
Returns
Type

Definition at line 197 of file SCR_EditableEntityComponentClass.c.

◆ GetIconBoneName()

string SCR_EditableEntityComponentClass::GetIconBoneName ( )
inlineprotected

Get bone name on which entity icon will be rendered.

Returns
Bone name

Definition at line 119 of file SCR_EditableEntityComponentClass.c.

◆ GetInfo() [1/2]

SCR_UIInfo SCR_EditableEntityComponentClass::GetInfo ( )
inlineprotected

Get information about the entity. When none exist, create a dummy one.

Returns
Info class

Definition at line 111 of file SCR_EditableEntityComponentClass.c.

◆ GetInfo() [2/2]

SCR_EditableEntityUIInfo SCR_EditableEntityComponentClass::GetInfo ( IEntityComponentSource componentSource)
inlinestaticprotected

Get UI info from SCR_EditableEntityComponent source

Parameters
[in]componentSourceComponent source - cannot be null
Returns
UI info

Definition at line 182 of file SCR_EditableEntityComponentClass.c.

◆ GetRandomVariant()

ResourceName SCR_EditableEntityComponentClass::GetRandomVariant ( ResourceName prefab)
inlinestaticprotected

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

Parameters
[in]prefabThe 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)

Definition at line 23 of file SCR_EditableEntityComponentClass.c.

◆ GetSlotPrefab()

ResourceName SCR_EditableEntityComponentClass::GetSlotPrefab ( IEntityComponentSource componentSource)
inlinestaticprotected

Get slot prefab from SCR_EditableEntityComponent source

Parameters
[in]componentSourceComponent source - cannot be null
Returns
Slot prefab

Definition at line 225 of file SCR_EditableEntityComponentClass.c.

◆ HasFlag()

bool SCR_EditableEntityComponentClass::HasFlag ( IEntityComponentSource componentSource,
EEditableEntityFlag flag )
inlinestaticprotected

Check if the SCR_EditableEntityComponent source has given flag

Parameters
[in]componentSourceComponent source
[in]flagQueried flag
Returns
true if it has the flag

Definition at line 252 of file SCR_EditableEntityComponentClass.c.

◆ HasVariants()

bool SCR_EditableEntityComponentClass::HasVariants ( ResourceName prefab)
inlinestaticprotected

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

Parameters
[in]prefabPrefab to check default variants of
Returns
True if any variants were assigned

Definition at line 80 of file SCR_EditableEntityComponentClass.c.

Member Data Documentation

◆ m_EntityInteraction

ref SCR_EditableEntityInteraction SCR_EditableEntityComponentClass::m_EntityInteraction
protected

Definition at line 14 of file SCR_EditableEntityComponentClass.c.

◆ m_EntityType

EEditableEntityType SCR_EditableEntityComponentClass::m_EntityType
protected

Definition at line 5 of file SCR_EditableEntityComponentClass.c.

◆ m_sIconBoneName

string SCR_EditableEntityComponentClass::m_sIconBoneName
protected

Definition at line 11 of file SCR_EditableEntityComponentClass.c.

◆ m_UIInfo

ref SCR_UIInfo SCR_EditableEntityComponentClass::m_UIInfo
protected

Definition at line 8 of file SCR_EditableEntityComponentClass.c.

◆ m_VariantData

ref SCR_EditableEntityVariantData SCR_EditableEntityComponentClass::m_VariantData
protected

Definition at line 17 of file SCR_EditableEntityComponentClass.c.

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