1. Epic GamesDeveloper
  3. UMassLODSubsystem

UMassLODSubsystem

Manager responsible to manage and synchronized available viewers

API > API/Plugins > API/Plugins/MassLOD

Inheritance Hierarchy

References

   
Module MassLOD
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassLOD/Public/MassLODSubsystem.h
Include #include "MassLODSubsystem.h"

Syntax

UCLASS (Config=Mass, defaultconfig)  
class UMassLODSubsystem : public UMassSubsystemBase

Remarks

Manager responsible to manage and synchronized available viewers

Variables

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = true bAllowNonPlayerViwerActors Whether using non-player actors as LOD Viewers is supported.
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = true bGatherPlayerControllers If true, all PlayerControllers will be gathered as viewers for LOD calculations.
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = true bGatherStreamingSources If true, all streaming sources will be gathered as viewers for LOD calculations.
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = false bUsePlayerPawnLocationInsteadOfCamera If set to true will prefer to use Player-owned Pawn's location and rotation over Player's camera as the viewer's location and rotation.

Functions

  Type Name Description
Protected function void

AddActorViewer ( AActor& ActorViewer
)

  
Protected function void

AddEditorViewer ( const int32 HashValue,
const int32 ClientIndex
)

 Adds the editor viewport client (identified via an index) as a viewer to the list and sends notification about addition
Protected function void

AddPlayerViewer ( APlayerController& PlayerController
)

 Adds the given player as a viewer to the list and sends notification about addition
Protected function void

AddStreamingSourceViewer ( const FName StreamingSourceName
)

 Adds the given streaming source as a viewer to the list and sends notification about addition
Protected function void

AddViewer ( APlayerController* PlayerController,
FName StreamingSourceName
)

  
Protected function uint32 Returns the next new viewer serial number
Public function FOnViewerAdded & Returns the delegate called when new viewer are added to the list
Public function FOnViewerRemoved & Returns the delegate called when viewer are removed from the list
Public function Const APlayerController * Returns PlayerController pointer from the viewer handle
Public function const TArray< FViewerInfo > & Synchronize the viewers if not done this frame and returns the updated array
Public function Const int32

GetValidViewerIdx ( const FMassViewerHandle& ViewerHandle
)

 Returns the index of the viewer if valid, otherwise INDEX_NONE is return
Public function Const FMassViewerHandle

GetViewerHandleFromActor ( const AActor& Actor
)

 Returns viewer handle from the PlayerController pointer
Public function Const FMassViewerHandle

GetViewerHandleFromPlayerController ( const APlayerController* PlayerController
)

  
Public function Const FMassViewerHandle

GetViewerHandleFromStreamingSource ( const FName StreamingSourceName
)

 Returns viewer handle from the streaming source name
Public function Const const TArray< FViewerInfo > & Returns the array of viewers
Public function Const bool  
Public function Const bool

IsValidViewer ( const FMassViewerHandle& ViewerHandle
)

 Checks the validity of a viewer handle
Protected function UFunction void

OnPlayerControllerEndPlay ( AActor* Actor,
EEndPlayReason::Type EndPlayReason
)

 Player controller EndPlay callback, removing viewers from the list
Protected function void

OnPrePhysicsPhaseStarted ( float DeltaTime
)

 Called at the start of the PrePhysics mass processing phase and calls SynchronizeViewers
Public function void

RegisterActorViewer ( AActor& ActorViewer
)

  
Protected function void

RemoveViewer ( const FMassViewerHandle& ViewerHandle
)

 Removes a viewer to the list and send notification about removal
Protected function void Synchronizes the viewers from the engine PlayerController list
Public function void

UnregisterActorViewer ( AActor& ActorViewer
)

  

Overridden from UMassSubsystemBase

  Type Name Description
Protected function Virtual void  
Protected function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

 USubsystem BEGIN.

Typedefs

Name Description
FOnViewerAdded  
FOnViewerRemoved  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page