1. Epic GamesDeveloper
  3. UMassRepresentationSubsystem

UMassRepresentationSubsystem

Subsystem responsible for all visual of mass agents, will handle actors spawning and static mesh instances

API > API/Plugins > API/Plugins/MassRepresentation

Inheritance Hierarchy

References

   
Module MassRepresentation
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassRepresentation/Public/MassRepresentationSubsystem.h
Include #include "MassRepresentationSubsystem.h"

Syntax

UCLASS ()  
class UMassRepresentationSubsystem : public UMassSubsystemBase

Remarks

Subsystem responsible for all visual of mass agents, will handle actors spawning and static mesh instances

Variables

  Type Name Description
Protected variable UProperty Transient TObjectPtr< UMassActorSpawnerSubsystem > ActorSpawnerSubsystem  
Protected variable TSharedPtr< FMassEntityManager > EntityManager  
Protected variable TMap< FMassEntityHandle, int32 > HandledMassAgents Keeping track of all the mass agent this subsystem is responsible for spawning actors
Protected variable float RetryMovedDistanceSq The time to wait before retrying a to spawn actor that failed
Protected variable float RetryTimeInterval The distance a failed spawned actor needs to move before we retry
Protected variable TSparseArray< FTemplateActorData > TemplateActors The array of all the template actors
Protected variable UProperty Transient TObjectPtr< UMassVisualizationComponent > VisualizationComponent The component that handles all the static mesh instances
Protected variable UProperty Transient TObjectPtr< AMassVisualizer > Visualizer The actor owning the above visualization component
Protected variable UProperty Transient TObjectPtr< UWorldPartitionSubsystem > WorldPartitionSubsystem  

Functions

  Type Name Description
Protected function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function FStaticMeshInstanceVisualizationDescHandle

AddVisualDescWithISMComponent ( const FStaticMeshInstanceVisualizationDesc& Desc,
UInstancedStaticMeshComponent& ISMComponent
)

 Creates a dedicated visual type described by host Desc and ties ISMComponent to it.
Public function FStaticMeshInstanceVisualizationDescHandle

AddVisualDescWithISMComponents ( const FStaticMeshInstanceVisualizationDesc& Desc,
TArrayView< TObjectPtr< UInstancedStaticMeshComponent > > ISMComponents
)

 Creates a dedicated visual type described by host Desc and ties given ISMComponents to it.
Public function bool

CancelSpawning ( const FMassEntityHandle MassAgent,
const int16 TemplateActorIndex,
FMassActorSpawnRequestHandle& SpawnRequestHandle
)

 Cancel spawning request that is matching the TemplateActorIndex
Protected function bool

CancelSpawningInternal ( const int16 TemplateActorIndex,
FMassActorSpawnRequestHandle& SpawnRequestHandle
)

  
Public function void Mark render state of the static mesh instances dirty
Public function Const bool

DoesActorMatchTemplate ( const AActor& Actor,
const int16 TemplateActorIndex
)

 Compare if an actor matches the registered template actor
Public function FStaticMeshInstanceVisualizationDescHandle Get the index of the static mesh visual type, will add a new one if does not exist
Public function int16

FindOrAddTemplateActor ( const TSubclassOf< AActor >& ActorClass
)

 Store the template actor uniquely and return an index to it
Public function Const UMassActorSpawnerSubsystem *  
Public function Const const FMassISMCSharedData *

GetISMCSharedDataForDescriptionIndex ( const int32 DescriptionIndex
)

 Fetches FMassISMCSharedData indicated by DescriptionIndex, or nullptr if it's not a valid index
Public function Const const FMassISMCSharedData *

GetISMCSharedDataForInstancedStaticMesh ( const UInstancedStaticMeshComponent* ISMC
)

 Fetches FMassISMCSharedData indicated by an ISMC, or nullptr if the ISMC is not represented by any shared data.
Public function FMassInstancedStaticMeshInfoArrayView  
Public function AActor *

GetOrSpawnActorFromTemplate ( const FMassEntityHandle MassAgent,
const FTransform& Transform,
const int16 TemplateActorIndex,
FMassActorSpawnRequestHandle& InOutSpawnRequestHandle,
float Priority,
FMassActorPreSpawnDelegate ActorPreSpawnDelegate,
FMassActorPostSpawnDelegate ActorPostSpawnDelegate
)

 Get or spawn an actor from the TemplateActorIndex
Public function TSubclassOf< AActor >

GetTemplateActorClass ( const int16 TemplateActorIndex
)

  
Public function Const bool

IsCollisionLoaded ( const FName TargetGrid,
const FTransform& Transform
)

  
Protected function void  
Protected function void  
Protected function Const void

OnProcessingPhaseStarted ( const float DeltaSeconds,
const EMassProcessingPhase Phase
)

 Needed for batching the update of static mesh transform
Public function void Release all references to static meshes and template actors Use with caution, all entities using this representation subsystem must be destroy otherwise they will point to invalid resources
Public function void

ReleaseTemplate ( const TSubclassOf< AActor >& ActorClass
)

 Responds to the FMassEntityTemplate getting destroyed, and releases reference to corresponding Actor in TemplateActors
Public function bool

ReleaseTemplateActor ( const FMassEntityHandle MassAgent,
const int16 TemplateActorIndex,
AActor* ActorToRelease,
bool bImmediate
)

 Release an actor that is matching the TemplateActorIndex
Protected function bool

ReleaseTemplateActorInternal ( const int16 TemplateActorIndex,
AActor* ActorToRelease,
bool bImmediate
)

  
Public function bool

ReleaseTemplateActorOrCancelSpawning ( const FMassEntityHandle MassAgent,
const int16 TemplateActorIndex,
AActor* ActorToRelease,
FMassActorSpawnRequestHandle& SpawnRequestHandle
)

 Release an actor or cancel its spawning if it is matching the TemplateActorIndex
Public function void

RemoveISMComponent ( UInstancedStaticMeshComponent& ISMComponent
)

 Removes the visualization data associated with the given ISM component.
Public function void Removes all data associated with a given VisualizationIndex.
Protected function  

UE_MT_DECLARE_RW_ACCESS_DETECTOR ( TemplateActorsMTAccessDetector
)

  

Overridden from UMassSubsystemBase

  Type Name Description
Protected function Virtual void  
Protected function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

 USubsystem BEGIN.

Classes

  Type Name Description
Protected struct FTemplateActorData    
Protected struct FTemplateActorEqualsPredicate    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page