Navigation
API > API/Plugins > API/Plugins/VPRoles
Subsystem for common Virtual Production roles operations. The machine role(s) in a virtual production context read from the command line. ie. "-VPRole=[Role.SubRole1|Role.SubRole2]"
| Name | UVirtualProductionRolesSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Experimental/VirtualProduction/VPRoles/Source/VPRoles/Public/VPRolesSubsystem.h |
| Include Path | #include "VPRolesSubsystem.h" |
Syntax
UCLASS ()
class UVirtualProductionRolesSubsystem : public UEngineSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UVirtualProductionRolesSubsystem
Classes
| Name | Remarks |
|---|---|
| FOnRolesChanged |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnRolesChangedNative | TMulticastDelegate_OneParam< void, const TArray< FString > & > | VPRolesSubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnRolesChangedBP | FOnRolesChanged | Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc. | VPRolesSubsystem.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasCommandLineRoles | bool | Whether command line roles were specified. | VPRolesSubsystem.h | |
| bUseCommandLineRoles | bool | Whether command line roles should be used. | VPRolesSubsystem.h | |
| CommandLineRoles | TPimplPtr< FGameplayTagContainer > | Holds the role container populated from the roles specified on the command line. | VPRolesSubsystem.h | |
| OnRolesChangedNative | FOnRolesChangedNative | Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc. | VPRolesSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Add a new virtual production role. | VPRolesSubsystem.h |
|
|
| Get the currently active Virtual Production roles. | VPRolesSubsystem.h |
|
|
FString GetActiveRolesString() |
VPRolesSubsystem.h |
|
|
| Get all available roles that can be set as current. | VPRolesSubsystem.h |
|
|
FName GetDefaultRoleSource() |
VPRolesSubsystem.h | ||
const FGameplayTagContainer & GetRolesContainer_Private () |
Get the roles container, either from the command line or from the VP Roles settings. | VPRolesSubsystem.h | |
const TSet< FName > & GetRoleSources() |
VPRolesSubsystem.h | ||
bool HasActiveRole
(
const FString& Role |
VPRolesSubsystem.h |
|
|
bool HasActiveRole
(
const FGameplayTag& Role |
VPRolesSubsystem.h | ||
bool HasCommandLineRoles() |
VPRolesSubsystem.h | ||
bool IsUsingCommandLineRoles() |
VPRolesSubsystem.h | ||
FOnRolesChangedNative & OnRolesChanged() |
Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc. | VPRolesSubsystem.h | |
bool RemoveRole
(
const FString& RoleName |
Remove a virtual production role. | VPRolesSubsystem.h |
|
void SetActiveRoles
(
const TArray< FString >& Roles |
Set the current Virtual Production roles. | VPRolesSubsystem.h |
|
void UseCommandLineRoles
(
bool bUseCommandLineRoles |
Set whether the command line roles should be used if any were specified. | VPRolesSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
VPRolesSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
VPRolesSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FGameplayTagContainer & GetRolesContainerFallback() |
Fallback handler that returns an empty tag container. | VPRolesSubsystem.h |