UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
MassCommands.h File Reference
#include "ProfilingDebugging/CsvProfilerConfig.h"
#include "AutoRTFM.h"
#include "Misc/MTTransactionallySafeAccessDetector.h"
#include "MassEntityTypes.h"
#include "MassEntityUtils.h"
#include "MassEntityManager.h"
#include "MassDebuggerBreakpoints.h"
#include "MassCommands.generated.h"

Go to the source code of this file.

Classes

struct  UE::Mass::Command::TCommandTraits< T >
 
struct  FMassBatchedCommand
 
struct  FMassBatchedEntityCommand
 
struct  FMassCommandDestroyEntities
 
struct  FMassCommandAddFragmentsInternal< CheckTime, TTypes >
 
struct  FMassCommandRemoveFragmentsInternal< CheckTime, TTypes >
 
struct  FMassCommandChangeTags
 
struct  FMassCommandAddTagsInternal< CheckTime, TTypes >
 
struct  FMassCommandRemoveTagsInternal< CheckTime, TTypes >
 
struct  FMassCommandSwapTagsInternal< CheckTime, TOld, TNew >
 
struct  FMassCommandAddFragmentInstances< TOthers >
 
struct  FMassCommandAddElement
 
struct  UE::Mass::Command::TCommandTraits< FMassCommandAddElement >
 
struct  FMassCommandBuildEntity< TOthers >
 
struct  FMassCommandBuildEntityWithSharedFragments< TSharedFragmentValues, TOthers >
 
struct  FMassCommandBuildEntityWithSharedFragments< TSharedFragmentValues, TOthers >::FPerSharedFragmentsHashData
 
struct  FMassDeferredCommand< OpType >
 

Namespaces

namespace  UE
 
namespace  UE::Mass
 
namespace  UE::Mass::Utils
 
namespace  UE::Mass::Command
 

Macros

#define DEBUG_NAME(Name)
 
#define DEBUG_NAME_PARAM(Name)
 
#define FORWARD_DEBUG_NAME_PARAM
 

Typedefs

template<typename... TTypes>
using FMassCommandAddFragments = FMassCommandAddFragmentsInternal< EMassCommandCheckTime::CompileTimeCheck, TTypes... >
 
template<typename... TTypes>
using FMassCommandRemoveFragments = FMassCommandRemoveFragmentsInternal< EMassCommandCheckTime::CompileTimeCheck, TTypes... >
 
template<typename T >
using FMassCommandAddTag = FMassCommandAddTagsInternal< EMassCommandCheckTime::CompileTimeCheck, T >
 
template<typename... TTypes>
using FMassCommandAddTags = FMassCommandAddTagsInternal< EMassCommandCheckTime::CompileTimeCheck, TTypes... >
 
template<typename T >
using FMassCommandRemoveTag = FMassCommandRemoveTagsInternal< EMassCommandCheckTime::CompileTimeCheck, T >
 
template<typename... TTypes>
using FMassCommandRemoveTags = FMassCommandRemoveTagsInternal< EMassCommandCheckTime::CompileTimeCheck, TTypes... >
 
template<typename TOld , typename TNew >
using FMassCommandSwapTags = FMassCommandSwapTagsInternal< EMassCommandCheckTime::CompileTimeCheck, TOld, TNew >
 
using FMassDeferredCreateCommand = FMassDeferredCommand< EMassCommandOperationType::Create >
 
using FMassDeferredAddCommand = FMassDeferredCommand< EMassCommandOperationType::Add >
 
using FMassDeferredRemoveCommand = FMassDeferredCommand< EMassCommandOperationType::Remove >
 
using FMassDeferredChangeCompositionCommand = FMassDeferredCommand< EMassCommandOperationType::ChangeComposition >
 
using FMassDeferredSetCommand = FMassDeferredCommand< EMassCommandOperationType::Set >
 
using FMassDeferredDestroyCommand = FMassDeferredCommand< EMassCommandOperationType::Destroy >
 

Enumerations

enum class  EMassCommandOperationType : uint8 {
  None , Create , Add , Remove ,
  ChangeComposition , Set , Destroy , MAX
}
 
enum class  EMassCommandCheckTime : bool { RuntimeCheck = true , CompileTimeCheck = false }
 

Functions

template<typename BitSetType , EMassCommandCheckTime CheckTime, typename... TTypes>
BitSetType UE::Mass::Utils::ConstructBitSet ()
 
template<EMassCommandCheckTime CheckTime, typename... TTypes>
FMassFragmentBitSet UE::Mass::Utils::ConstructFragmentBitSet ()
 
template<EMassCommandCheckTime CheckTime, typename... TTypes>
FMassTagBitSet UE::Mass::Utils::ConstructTagBitSet ()
 

Macro Definition Documentation

◆ DEBUG_NAME

#define DEBUG_NAME (   Name)

◆ DEBUG_NAME_PARAM

#define DEBUG_NAME_PARAM (   Name)

◆ FORWARD_DEBUG_NAME_PARAM

#define FORWARD_DEBUG_NAME_PARAM

Typedef Documentation

◆ FMassCommandAddFragments

◆ FMassCommandAddTag

◆ FMassCommandAddTags

◆ FMassCommandRemoveFragments

◆ FMassCommandRemoveTag

◆ FMassCommandRemoveTags

◆ FMassCommandSwapTags

◆ FMassDeferredAddCommand

◆ FMassDeferredChangeCompositionCommand

◆ FMassDeferredCreateCommand

◆ FMassDeferredDestroyCommand

◆ FMassDeferredRemoveCommand

◆ FMassDeferredSetCommand

Enumeration Type Documentation

◆ EMassCommandCheckTime

Enumerator
RuntimeCheck 
CompileTimeCheck 

◆ EMassCommandOperationType

Enum used by MassBatchCommands to declare their "type". This data is later used to group commands so that command effects are applied in a controllable fashion Important: if changed make sure to update FMassCommandBuffer::Flush.CommandTypeOrder as well

Enumerator
None 
Create 
Add 
Remove 
ChangeComposition 
Set 
Destroy 
MAX