Navigation
API > API/Plugins > API/Plugins/MassLOD
Manager responsible to manage and synchronized available viewers
| Name | UMassLODSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MassGameplay/Source/MassLOD/Public/MassLODSubsystem.h |
| Include Path | #include "MassLODSubsystem.h" |
Syntax
UCLASS (MinimalAPI, Config=Mass, defaultconfig)
class UMassLODSubsystem : public UMassSubsystemBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem → UMassSubsystemBase → UMassLODSubsystem
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnViewerAdded | TMulticastDelegate_OneParam< void, const FViewerInfo &ViewerInfo > | MassLODSubsystem.h | |
| FOnViewerRemoved | TMulticastDelegate_OneParam< void, const FViewerInfo &ViewerInfo > | MassLODSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIgnorePlayerControllersDueToSimulation | bool | MassLODSubsystem.h | ||
| bUseEditorLevelViewports | bool | MassLODSubsystem.h | ||
| LastSynchronizedFrame | uint64 | MassLODSubsystem.h | ||
| OnViewerAddedDelegate | FOnViewerAdded | Delegates to notify anyone who needs to know about viewer changes | MassLODSubsystem.h | |
| OnViewerRemovedDelegate | FOnViewerRemoved | MassLODSubsystem.h | ||
| RegisteredActorViewers | TArray< TObjectPtr< AActor > > | MassLODSubsystem.h |
|
|
| ViewerFreeIndices | TArray< int32 > | Free list of indices in the sparse viewer array | MassLODSubsystem.h | |
| ViewerMap | TMap< uint32, FMassViewerHandle > | The map that do reverse look up to get ViewerHandle | MassLODSubsystem.h |
|
| Viewers | TArray< FViewerInfo > | The actual array of viewer's information | MassLODSubsystem.h |
|
| ViewerSerialNumberCounter | uint32 | Viewer serial number counter | MassLODSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DebugSetGatherPlayers
(
const bool bInValue |
MassLODSubsystem.h | ||
void DebugSetUsePlayerPawnLocationInsteadOfCamera
(
const bool bInValue |
MassLODSubsystem.h | ||
void DebugUnregisterActorViewer() |
MassLODSubsystem.h | ||
FOnViewerAdded & GetOnViewerAddedDelegate() |
Returns the delegate called when new viewer are added to the list | MassLODSubsystem.h | |
FOnViewerRemoved & GetOnViewerRemovedDelegate() |
Returns the delegate called when viewer are removed from the list | MassLODSubsystem.h | |
APlayerController * GetPlayerControllerFromViewerHandle
(
const FMassViewerHandle& ViewerHandle |
Returns PlayerController pointer from the viewer handle | MassLODSubsystem.h | |
const TArray< FViewerInfo > & GetSynchronizedViewers() |
Synchronize the viewers if not done this frame and returns the updated array | MassLODSubsystem.h | |
int32 GetValidViewerIdx
(
const FMassViewerHandle& ViewerHandle |
Returns the index of the viewer if valid, otherwise INDEX_NONE is return | MassLODSubsystem.h | |
FMassViewerHandle GetViewerHandleFromActor
(
const AActor& Actor |
Returns viewer handle from the PlayerController pointer | MassLODSubsystem.h | |
FMassViewerHandle GetViewerHandleFromStreamingSource
(
const FName StreamingSourceName |
Returns viewer handle from the streaming source name | MassLODSubsystem.h | |
const TArray< FViewerInfo > & GetViewers() |
Returns the array of viewers | MassLODSubsystem.h | |
bool IsUsingPlayerPawnLocationInsteadOfCamera() |
MassLODSubsystem.h | ||
bool IsValidViewer
(
const FMassViewerHandle& ViewerHandle |
Checks the validity of a viewer handle | MassLODSubsystem.h | |
void RegisterActorViewer
(
AActor& ActorViewer |
MassLODSubsystem.h | ||
void UnregisterActorViewer
(
AActor& ActorViewer |
MassLODSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddActorViewer
(
AActor& ActorViewer |
MassLODSubsystem.h | ||
void AddEditorViewer
(
const int32 HashValue, |
Adds the editor viewport client (identified via an index) as a viewer to the list and sends notification about addition | MassLODSubsystem.h | |
void AddPlayerViewer
(
APlayerController& PlayerController |
Adds the given player as a viewer to the list and sends notification about addition | MassLODSubsystem.h | |
void AddStreamingSourceViewer
(
const FName StreamingSourceName |
Adds the given streaming source as a viewer to the list and sends notification about addition | MassLODSubsystem.h | |
uint32 GetNextViewerSerialNumber() |
Returns the next new viewer serial number | MassLODSubsystem.h | |
void OnPlayerControllerEndPlay
(
AActor* Actor, |
Player controller EndPlay callback, removing viewers from the list | MassLODSubsystem.h | |
void OnPrePhysicsPhaseStarted
(
float DeltaTime |
Called at the start of the PrePhysics mass processing phase and calls SynchronizeViewers | MassLODSubsystem.h | |
void RemoveViewer
(
const FMassViewerHandle& ViewerHandle |
Removes a viewer to the list and send notification about removal | MassLODSubsystem.h | |
void SynchronizeViewers() |
Synchronizes the viewers from the engine PlayerController list | MassLODSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
MassLODSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
USubsystem BEGIN. | MassLODSubsystem.h |