1. Epic GamesDeveloper
  3. FMassEntityConfig

FMassEntityConfig

Describes a Mass agent to spawn.

API > API/Plugins > API/Plugins/MassSpawner

References

   
Module MassSpawner
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassSpawner/Public/MassEntityConfigAsset.h
Include #include "MassEntityConfigAsset.h"

Syntax

USTRUCT&40;&41;  
struct FMassEntityConfig

Remarks

Describes a Mass agent to spawn. The struct can be embedded to allow last minute changes to the agent (i.e. for debugging). The agent config describes a unique list of features which are used to create an entity template. Derived configs can override parent features.

Variables

  Type Name Description
Protected variable UProperty Transient TObjectPtr< UObject > ConfigOwner  
Protected variable UProperty Category, EditAnywhere TObjectPtr< const UMassEntityConfigAsset > Parent Reference to parent config asset
Protected variable UProperty Category, EditAnywhere instanced TArray< TObjectPtr< UMassEntityTraitBase > > Traits Array of unique traits of this config

Constructors

  Type Name Description
Public function    
Public function  

FMassEntityConfig ( UObject& InOwner
)

  

Functions

  Type Name Description
Public function void Adds Trait to the collection of traits hosted by this FMassEntityConfig instance
Public function Const void

DestroyEntityTemplate ( const UWorld& World
)

  
Public function Const const UMassEntityTraitBase *

FindTrait ( TSubclassOf< UMassEntityTraitBase > TraitClass,
const bool bExactMatch
)

 Looks for a trait of the indicated type, accepting all child classes as well, unless bExactMatch == true
Protected function Const void Combines traits based on the config hierarchy and returns list of unique traits
Public function Const const FMassEntityTemplate &

GetEntityTemplateChecked ( const UWorld& World
)

 Fetches the EntityTemplate for given World, fails a check if one cannot be found.
Public function Const const FGuid &

GetGuid ()

  
Public function Const const FMassEntityTemplate & Create entity template based on the features included in this config.
Public function Const const UMassEntityConfigAsset *  
Public function Const TConstArrayView< UMassEntityTraitBase * >  
Public function Const bool

IsEmpty ()

  
Public function void

SetOwner ( UObject& InOwner
)

  
Public function void  
Public function bool

ValidateEntityTemplate ( const UWorld& World
)

 Validates if the entity template is well built

Deprecated Functions

  Type Name Description
Public function Const void

DestroyEntityTemplate ( const UWorld& World,
const UObject& ConfigOwner
)

 This flavor of DestroyEntityTemplate is deprecated. Use the one without the ConfigOwner parameter (now a property of the FMassEntityConfig itself)
Protected function Const void

GetCombinedTraits ( TArray< UMassEntityTraitBase* >& OutTraits,
TArray< const UObject* >& Visited,
const UObject& ConfigOwner
)

 This flavor of GetCombinedTraits is deprecated. Use the one without the ConfigOwner parameter (now a property of the FMassEntityConfig itself)
Public function Const const FMassEntityTemplate &

GetEntityTemplateChecked ( const UWorld& World,
const UObject& ConfigOwner
)

 This flavor of GetEntityTemplateChecked is deprecated. Use the one without the ConfigOwner parameter (now a property of the FMassEntityConfig itself)
Public function Const const FMassEntityTemplate &

GetOrCreateEntityTemplate ( const UWorld& World,
const UObject& ConfigOwner
)

 This flavor of GetOrCreateEntityTemplate is deprecated. Use the one without the ConfigOwner parameter (now a property of the FMassEntityConfig itself)
Public function bool

ValidateEntityTemplate ( const UWorld& World,
const UObject& ConfigOwner
)

 This flavor of ValidateEntityTemplate is deprecated. Use the one without the ConfigOwner parameter (now a property of the FMassEntityConfig itself)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page