Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MassRepresentation > UMassRepresentationSubsystem

Light Theme

Dark Theme

UMassRepresentationSubsystem

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UWorldSubsystem

UMassRepresentationSubsystem

UMassCrowdRepresentationSubsystem

References

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

Syntax

UCLASS()
class UMassRepresentationSubsystem : public UWorldSubsystem

Remarks

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

Variables

	Name	Description
UMassActorSpawn...	ActorSpawnerSubsystem
UMassEntitySubs...	EntitySubsystem
TMap< FMassEnti...	HandledMassAgents	Keeping track of all the mass agent this subsystem is responsible for spawning actors
float	RetryMovedDistanceSq	The time to wait before retrying a to spawn actor that failed
float	RetryTimeInterval	The distance a failed spawned actor needs to move before we retry
TArray< TSubcla...	TemplateActors	The array of all the template actors
FRWAccessDetect...	TemplateActorsMTAccessDetector
UMassVisualizat...	VisualizationComponent	The component that handles all the static mesh instances
AMassVisualizer...	Visualizer	The actor owning the above visualization component
UWorldPartition...	WorldPartitionSubsystem

Functions

	Name	Description
bool	CancelSpawning ( const FMassEntityHandle MassAgent, const int16 TemplateActorIndex, FMassActorSpawnRequestHandle& Spaw... )	Cancel spawning request that is matching the TemplateActorIndex
bool	CancelSpawningInternal ( const int16 TemplateActorIndex, FMassActorSpawnRequestHandle& Spaw... )
void	DirtyStaticMeshInstances()	Mark render state of the static mesh instances dirty
bool	DoesActorMatchTemplate ( const AActor& Actor, const int16 TemplateActorIndex )	Compare if an actor matches the registered template actor
int16	FindOrAddStaticMeshDesc ( const FStaticMeshInstanceVisualizat... )	Get the index of the static mesh visual type, will add a new one if does not exist
int16	FindOrAddTemplateActor ( const TSubclassOf< AActor >& Actor... )	Store the template actor uniquely and return an index to it
FMassInstanc...	GetMutableInstancedStaticMeshInfos()
AActor *	GetOrSpawnActorFromTemplate ( const FMassEntityHandle MassAgent, const FTransform& Transform, const int16 TemplateActorIndex, FMassActorSpawnRequestHandle& Spaw..., float Priority, FMassActorPreSpawnDelegate ActorPre..., FMassActorPostSpawnDelegate ActorPo... )	Get or spawn an actor from the TemplateActorIndex
TSubclassOf<...	GetTemplateActorClass ( const int16 TemplateActorIndex )
bool	IsCollisionLoaded ( const FName TargetGrid, const FTransform& Transform )
void	OnMassAgentComponentEntityAssociated ( const UMassAgentComponent& AgentCo... )
void	OnMassAgentComponentEntityDetaching ( const UMassAgentComponent& AgentCo... )
void	OnProcessingPhaseStarted ( const float DeltaSeconds, const EMassProcessingPhase Phase )	Needed for batching the update of static mesh transform
void	ReleaseAllResources()	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
bool	ReleaseTemplateActor ( const FMassEntityHandle MassAgent, const int16 TemplateActorIndex, AActor* ActorToRelease, bool bImmediate )	Release an actor that is matching the TemplateActorIndex
bool	ReleaseTemplateActorInternal ( const int16 TemplateActorIndex, AActor* ActorToRelease, bool bImmediate )
bool	ReleaseTemplateActorOrCancelSpawning ( const FMassEntityHandle MassAgent, const int16 TemplateActorIndex, AActor* ActorToRelease, FMassActorSpawnRequestHandle& Spaw... )	Release an actor or cancel its spawning if it is matching the TemplateActorIndex

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	USubsystem BEGIN.