1. Epic GamesDeveloper
  3. UVirtualProductionRolesSubsystem

UVirtualProductionRolesSubsystem

Subsystem for common Virtual Production roles operations.

API > API/Plugins > API/Plugins/VPRoles

Inheritance Hierarchy

References

   
Module VPRoles
Header /Engine/Plugins/Experimental/VirtualProduction/VPRoles/Source/VPRoles/Public/VPRolesSubsystem.h
Include #include "VPRolesSubsystem.h"

Syntax

UCLASS&40;&41;  
class UVirtualProductionRolesSubsystem : public UEngineSubsystem

Remarks

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]"

Variables

  Type Name Description
Public variable UProperty Category, Meta BlueprintAssignable FOnRolesChanged OnRolesChangedBP Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category bool

AddRole ( const FString& RoleName
)

 Add a new virtual production role.
Public function Const UFunction BlueprintCallable, Category TArray< FString > Get the currently active Virtual Production roles.
Public function Const UFunction BlueprintCallable, Category FString  
Public function Const UFunction BlueprintCallable, Category TArray< FString > Get all available roles that can be set as current.
Public function Const FName  
Public function Const const FGameplayTagContainer & Get the roles container, either from the command line or from the VP Roles settings.
Public function Const const TSet< FName > &  
Public function Const bool

HasActiveRole ( const FGameplayTag& Role
)

  
Public function Const UFunction BlueprintCallable, Category bool

HasActiveRole ( const FString& Role
)

  
Public function Const bool  
Public function Const bool  
Public function FOnRolesChangedNative & Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc.
Public function UFunction BlueprintCallable, Category bool

RemoveRole ( const FString& RoleName
)

 Remove a virtual production role.
Public function UFunction BlueprintCallable, Category void

SetActiveRoles ( const TArray< FString >& Roles
)

 Set the current Virtual Production roles.
Public function void

UseCommandLineRoles ( bool bUseCommandLineRoles
)

 Set whether the command line roles should be used if any were specified.

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system

Classes

  Type Name Description
Public class FOnRolesChanged    

Enums

  Type Name Description
Private enum EGetRolesPtrSource    

Typedefs

Name Description
FOnRolesChangedNative  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page