unreal.VirtualProductionRolesSubsystem
¶
- class unreal.VirtualProductionRolesSubsystem(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
EngineSubsystem
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]”
C++ Source:
Plugin: VPRoles
Module: VPRoles
File: VPRolesSubsystem.h
Editor Properties: (see get_editor_property/set_editor_property)
on_roles_changed
(OnRolesChanged): [Read-Write] Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc.
- add_role(role_name) bool ¶
Add a new virtual production role. note: This will attempt to modify the underlying VProles.ini file so it must be checked out or made writable or the operation will fail.
- get_active_roles_string() str ¶
- Returns:
the currently active Virtual Production roles as a comma separated string representation.
- Return type:
- property on_roles_changed: OnRolesChanged¶
[Read-Write] Delegate called when the roles are modified, ie. role is added, current roles are replaced, etc.
- Type:
(OnRolesChanged)