Navigation
API > API/Plugins > API/Plugins/StageMonitorCommon
Settings for StageMonitor
| Name | FStageMonitorSettings |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitorCommon/Public/StageMonitoringSettings.h |
| Include Path | #include "StageMonitoringSettings.h" |
Syntax
USTRUCT ()
struct FStageMonitorSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStageMonitorSettings() |
StageMonitoringSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseRoleFiltering | bool | If true, Monitor will only autostart if machine has a role contained in SupportedRoles Once in editor, you can always start a monitor manually independently of the roles. | StageMonitoringSettings.h |
|
| DiscoveryMessageInterval | float | Interval between each discovery signal sent by Monitors | StageMonitoringSettings.h |
|
| SupportedRoles | FGameplayTagContainer | If checked, VP Role of this instance must be part of these roles to have the monitor operational | StageMonitoringSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ShouldAutoStartOnLaunch() |
Returns true if Monitor should start on launch. Can be overriden through commandline | StageMonitoringSettings.h |