1. Epic GamesDeveloper
  3. FMassCommandBuffer

FMassCommandBuffer

API > API/Runtime > API/Runtime/MassEntity

   
Name FMassCommandBuffer
Type struct
Header File /Engine/Source/Runtime/MassEntity/Public/MassCommandBuffer.h
Include Path #include "MassCommandBuffer.h"

Syntax

struct FMassCommandBuffer

Constructors

Name Remarks Include Path Unreal Specifiers

FMassCommandBuffer()

   MassCommandBuffer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMassCommandBuffer()

   MassCommandBuffer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveCommandsCounter int32   MassCommandBuffer.h  
AppendedCommandInstances TArray< TUniquePtr< FMassBatchedCommand > > Commands appended to this command buffer (via FMassCommandBuffer::MoveAppend). MassCommandBuffer.h  
AppendingCommandsCS FTransactionallySafeCriticalSection   MassCommandBuffer.h  
bIsFlushing bool Indicates that this specific MassCommandBuffer is currently flushing its contents MassCommandBuffer.h  
CommandInstances TArray< TUniquePtr< FMassBatchedCommand > > Commands created for this specific command buffer. MassCommandBuffer.h  
FMassEntityManager friend   MassCommandBuffer.h  
OwnerThreadId uint32 Identifies the thread where given FMassCommandBuffer instance was created. MassCommandBuffer.h  
PendingBatchCommandsDetector FRWTransactionallySafeAccessDetector   MassCommandBuffer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddFragment ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void AddFragment_RuntimeCheck ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void AddTag ( TConstArrayView< FMassEntityHandle > Entities
)

   MassCommandBuffer.h  

void AddTag ( FMassEntityHandle Entity
)

 The convenience function equivalent to calling PushCommand>(Entity) MassCommandBuffer.h  

void AddTag_RuntimeCheck ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void CancelCommands ()

 Removes any pending command instances This could be required for CommandBuffers that are queued to flush their commands on the game thread but the EntityManager is no longer available. MassCommandBuffer.h  

void DestroyEntities ( TArray< FMassEntityHandle >&& InEntitiesToDestroy
)

   MassCommandBuffer.h  

void DestroyEntities ( TConstArrayView< FMassEntityHandle > InEntitiesToDestroy
)

   MassCommandBuffer.h  

void DestroyEntity ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  
Updates the OwnerThreadId which indicates that the given command buffer instance is being used in a different thread now. MassCommandBuffer.h  

SIZE_T GetAllocatedSize()

   MassCommandBuffer.h  

bool HasPendingCommands()

   MassCommandBuffer.h  

bool IsFlushing()

   MassCommandBuffer.h  

bool IsInOwnerThread()

   MassCommandBuffer.h  

void MoveAppend ( FMassCommandBuffer& InOutOther
)

 Appends the commands from the passed buffer into this one MassCommandBuffer.h  

void PushCommand ( TArgs&&... InArgs
)

   MassCommandBuffer.h  

void PushCommand ( const FMassEntityHandle Entity
)

 Adds a new entry to a given TCommand batch command instance MassCommandBuffer.h  

void PushCommand ( TConstArrayView< FMassEntityHandle > Entities
)

   MassCommandBuffer.h  

void PushCommand ( const FMassEntityHandle Entity,
TArgs&&... InArgs
)

 Adds a new entry to a given TCommand batch command instance MassCommandBuffer.h  

void PushUniqueCommand ( TUniquePtr< FMassBatchedCommand >&& CommandInstance
)

 Ordinary PushCommand calls try to reuse existing command instances (as stored in CommandInstances) based on their type. MassCommandBuffer.h  

void RemoveFragment ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void RemoveFragment_RuntimeCheck ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void RemoveTag ( FMassEntityHandle Entity
)

 The convenience function equivalent to calling PushCommand>(Entity) MassCommandBuffer.h  

void RemoveTag ( TConstArrayView< FMassEntityHandle > Entities
)

   MassCommandBuffer.h  

void RemoveTag_RuntimeCheck ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

void SwapTags ( FMassEntityHandle Entity
)

 The convenience function equivalent to calling PushCommand>(Entity) MassCommandBuffer.h  

void SwapTags_RuntimeCheck ( FMassEntityHandle Entity
)

   MassCommandBuffer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page