UMassEntityTraitBase | Unreal Engine 5.8 Documentation

API > API/Plugins > API/Plugins/MassSpawner

Base class for Mass Entity Traits. An entity trait is a set of fragments that create a logical trait tha makes sense to end use (i.e. replication, visualization). The template building method allows to configure some fragments based on properties or cached values. For example, a fragment can be added based on a referenced asset, or some memory hungry settings can be cached and just and index stored on a fragment.


Name	UMassEntityTraitBase
Type	class
Header File	/Engine/Plugins/Runtime/MassGameplay/Source/MassSpawner/Public/MassEntityTraitBase.h
Include Path	#include "MassEntityTraitBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, EditInlineNew, CollapseCategories, Config=Mass,  
       defaultconfig)  
class UMassEntityTraitBase : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMassEntityTraitBase

Derived Classes

UMassEntityTraitBase derived class hierarchy

Structs

Name	Remarks
FAdditionalTraitRequirements	This is a type wrapping an existing TArray to limit how users can interact with the contained data.

Typedefs

Name	Type	Remarks	Include Path
FOnNewTraitType	TMulticastDelegate_OneParam< void, UMassEntityTraitBase & >		MassEntityTraitBase.h

Constants

Name	Type	Remarks	Include Path
OnNewTraitTypeEvent	FOnNewTraitType		MassEntityTraitBase.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
ValidTargetConfig	EProcessorExecutionFlags	Configures which configurations are targeted by this trait.	MassEntityTraitBase.h	EditAnywhere Category=Mass

Functions

Public Virtual

Name	Remarks	Include Path
virtual void BuildTemplate ( FMassEntityTemplateBuildContext& BuildContext, const UWorld& World ) const	Appends items into the entity template required for the trait.	MassEntityTraitBase.h
virtual void DestroyTemplate ( const UWorld& World ) const		MassEntityTraitBase.h
virtual bool ValidateTemplate ( const FMassEntityTemplateBuildContext& BuildContext, const UWorld& World, FAdditionalTraitRequirements& OutTraitRequirements ) const	Called once all traits have been processed and fragment requirements have been checked.	MassEntityTraitBase.h

Protected Virtual

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostInitProperties()		MassEntityTraitBase.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FOnNewTraitType & GetOnNewTraitTypeEvent()		MassEntityTraitBase.h

Navigation